mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-01 07:33:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Patch #1434038: property() now uses the getter's docstring if there is

Browse source 
no "doc" argument given. This makes it possible to legitimately use
property() as a decorator to produce a read-only property.
This commit is contained in:
Georg Brandl 2006-03-08 18:09:27 +00:00
parent f3c4ad1410
commit 533ff6fc06
4 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Doc/lib/libfuncs.tex
View file

@ -771,7 +771,12 @@ class C(object):
x = property(getx, setx, delx, "I'm the 'x' property.")
\end{verbatim}
If given, \var{doc} will be the docstring of the property attribute.
Otherwise, the property will copy \var{fget}'s docstring (if it
exists).
\versionadded{2.2}
\versionchanged[Use \var{fget}'s docstring if no \var{doc} given]{2.5}
\end{funcdesc}
\begin{funcdesc}{range}{\optional{start,} stop\optional{, step}}