[Python-checkins] cpython (2.7): Document that @property can incorporate a docstring from the getter method.
raymond.hettinger
python-checkins at python.org
Sun Nov 24 23:43:11 CET 2013
http://hg.python.org/cpython/rev/0a148a029328
changeset: 87526:0a148a029328
branch: 2.7
parent: 87512:77e3e395f446
user: Raymond Hettinger <python at rcn.com>
date: Sun Nov 24 14:43:04 2013 -0800
summary:
Document that @property can incorporate a docstring from the getter method. Improve readabilty with additional whitespace.
files:
Objects/descrobject.c | 14 +++++++++-----
1 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/Objects/descrobject.c b/Objects/descrobject.c
--- a/Objects/descrobject.c
+++ b/Objects/descrobject.c
@@ -1363,21 +1363,25 @@
"\n"
"fget is a function to be used for getting an attribute value, and likewise\n"
"fset is a function for setting, and fdel a function for del'ing, an\n"
-"attribute. Typical use is to define a managed attribute x:\n"
+"attribute. Typical use is to define a managed attribute x:\n\n"
"class C(object):\n"
" def getx(self): return self._x\n"
" def setx(self, value): self._x = value\n"
" def delx(self): del self._x\n"
" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
"\n"
-"Decorators make defining new properties or modifying existing ones easy:\n"
+"Decorators make defining new properties or modifying existing ones easy:\n\n"
"class C(object):\n"
" @property\n"
-" def x(self): return self._x\n"
+" def x(self):\n"
+" \"\I am the 'x' property.\"\n"
+" return self._x\n"
" @x.setter\n"
-" def x(self, value): self._x = value\n"
+" def x(self, value):\n"
+" self._x = value\n"
" @x.deleter\n"
-" def x(self): del self._x\n"
+" def x(self):\n"
+" del self._x\n"
);
static int
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list