]> granicus.if.org Git - python/commitdiff
Document that @property can incorporate a docstring from the getter method. Improve...
authorRaymond Hettinger <python@rcn.com>
Sun, 24 Nov 2013 22:43:04 +0000 (14:43 -0800)
committerRaymond Hettinger <python@rcn.com>
Sun, 24 Nov 2013 22:43:04 +0000 (14:43 -0800)
Objects/descrobject.c

index 7bf1859483b03e70740373b859e8ab8524867f46..3bd22762b6827d0da6cd77950761ea354861e00d 100644 (file)
@@ -1363,21 +1363,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