summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2013-11-24 22:53:29 (GMT)
committerRaymond Hettinger <python@rcn.com>2013-11-24 22:53:29 (GMT)
commit97fc2ba6bf4624a7cec376019f3a86a5a5db5967 (patch)
tree895061a6637fb5f4f97dda94d59a0b7418da9e2f
parent45059eb1d0788aa74ea383c89cf2f8c7a32fd2aa (diff)
downloadcpython-97fc2ba6bf4624a7cec376019f3a86a5a5db5967.zip
cpython-97fc2ba6bf4624a7cec376019f3a86a5a5db5967.tar.gz
cpython-97fc2ba6bf4624a7cec376019f3a86a5a5db5967.tar.bz2
Document that @property can incorporate a docstring from the getter method. Improve readabilty with additional whitespace.
-rw-r--r--Objects/descrobject.c14
1 files changed, 9 insertions, 5 deletions
diff --git a/Objects/descrobject.c b/Objects/descrobject.c
index abcc002..1e9570c 100644
--- a/Objects/descrobject.c
+++ b/Objects/descrobject.c
@@ -1512,21 +1512,25 @@ PyDoc_STRVAR(property_doc,
"\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