From: Raymond Hettinger <python@rcn.com>
Date: Sun, 24 Nov 2013 22:53:29 +0000 (-0800)
Subject: Document that @property can incorporate a docstring from the getter method.  Improve... 
X-Git-Tag: v3.4.0b2~505^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=97fc2ba6bf4624a7cec376019f3a86a5a5db5967;p=python

Document that @property can incorporate a docstring from the getter method.  Improve readabilty with additional whitespace.
---

diff --git a/Objects/descrobject.c b/Objects/descrobject.c
index abcc0020ff..1e9570c34a 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