Repository navigation
Bad usage example in id() DocString #77481
Description
| BPO | 33300 |
|---|---|
| Nosy | @vadmium |
| Superseder |
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 = <Date 2020-10-31.15:16:34.171>
created_at = <Date 2018-04-17.20:02:15.239>
labels = ['docs']
title = 'Bad usage example in id() DocString'
updated_at = <Date 2020-10-31.15:16:34.171>
user = 'https://bugs.python.org/gneff'bugs.python.org fields:
activity = <Date 2020-10-31.15:16:34.171>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-10-31.15:16:34.171>
closer = 'iritkatriel'
components = ['Documentation']
creation = <Date 2018-04-17.20:02:15.239>
creator = 'gneff'
dependencies = []
files = []
hgrepos = []
issue_num = 33300
keywords = []
message_count = 2.0
messages = ['315410', '315416']
nosy_count = 3.0
nosy_names = ['docs@python', 'martin.panter', 'gneff']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = 'resolved'
status = 'closed'
superseder = '21314'
type = None
url = 'https://bugs.python.org/issue33300'
versions = ['Python 3.5', 'Python 3.6']
Activity
gneff commentedon Apr 17, 2018
The DocString for id() in 3.5.x & 3.6.x seems to have an incorrect usage example, specifically
id(obj, /).This is present in 3.5.x & 3.6.x. It does not appear to be present in 2.7.x or 3.4.x.:
vadmium commentedon Apr 17, 2018
It is supposed to be a function signature, similar to the syntax when you define your own function, rather than a usage example of calling the function.
In this case, the slash notation is described by PEP-457. It is supposed to indicate that “obj” is a positional-only parameter, and not a keyword parameter. If that is what you think is incorrect, perhaps you can suggest a place to explain the notation in bpo-21314.