python / python/cpython

Profile 'builtins' parameter documentation missing

Open
#84,386 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs stdlib
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 40205
Nosy @terryjreedy, @bharel

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-04-06.14:43:33.212>
labels = ['3.8', '3.7', 'library', '3.9', 'docs']
title = "Profile 'builtins' parameter documentation missing"
updated_at = <Date 2020-04-11.01:16:06.060>
user = 'https://github.com/bharel'

bugs.python.org fields:

activity = <Date 2020-04-11.01:16:06.060>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2020-04-06.14:43:33.212>
creator = 'bar.harel'
dependencies = []
files = []
hgrepos = []
issue_num = 40205
keywords = []
message_count = 2.0
messages = ['365859', '366173']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'docs@python', 'bar.harel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40205'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The payload does not name a documentation file or test. Locate the documentation entry for the profile function's builtins parameter, add the missing explanation, and verify that the resulting reference documentation clearly describes it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.