classification
Title: Bad usage example in id() DocString
Type: Stage:
Components: Documentation Versions: Python 3.6, Python 3.5
process
Status: pending Resolution: duplicate
Dependencies: Superseder: Document '/' in signatures
View: 21314
Assigned To: docs@python Nosy List: docs@python, gneff, martin.panter
Priority: normal Keywords:

Created on 2018-04-17 20:02 by gneff, last changed 2018-08-11 22:11 by martin.panter.

Messages (2)
msg315410 - (view) Author: Glen Neff (gneff) Date: 2018-04-17 20:02
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.:

Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:54:40) [MSC v.1900 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> help(id)
Help on built-in function id in module builtins:

id(obj, /)
    Return the identity of an object.

    This is guaranteed to be unique among simultaneously existing objects.
    (CPython uses the object's memory address.)

>>>
msg315416 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2018-04-17 20:52
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 Issue 21314.
History
Date User Action Args
2018-08-11 22:11:03martin.pantersetstatus: open -> pending
resolution: duplicate
2018-04-17 20:52:05martin.pantersetsuperseder: Document '/' in signatures

messages: + msg315416
nosy: + martin.panter
2018-04-17 20:02:15gneffcreate