[docs] Documentation bug in 'property' function
Fred Chapman
fwchapman at gmail.com
Mon Mar 25 01:52:09 EDT 2019
Hello,
I believe I've found a mistake in the documentation for the *property*
function:
https://docs.python.org/3/library/functions.html#property
The relevant excerpt is right at the top:
*class *property(*fget=None*, *fset=None*, *fdel=None*, *doc=None*)
<https://docs.python.org/3/library/functions.html#property>
Return a property attribute.
*I believe attribute should actually say object.*
According to the first word of the first line of the property function
documentation (*class*), the property function is a class constructor.
Consequently, its function call returns an *instance of the class*, which
is an *object*. In fact, the documentation for the property function uses
the phrase *property object* three times.
Moreover, a property object has *three* method attributes, not just one:
*getter*, *setter*, and *deleter*. "Return a property attribute" is
singular (one) rather than plural (three), which makes no sense here.
Am I correct or have I misunderstood something?
Thank you,
Fred Chapman
Content Editor
fwchapman.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20190325/17ccf28e/attachment.html>
More information about the docs
mailing list