]> granicus.if.org Git - python/commitdiff
Added __doc__ to predefined module attributes.
authorGuido van Rossum <guido@python.org>
Wed, 26 Jun 1996 19:29:21 +0000 (19:29 +0000)
committerGuido van Rossum <guido@python.org>
Wed, 26 Jun 1996 19:29:21 +0000 (19:29 +0000)
Doc/ref/ref3.tex
Doc/ref3.tex

index 60af2dc94a0eeb63cb1654e639358018307c27b1..e017e263336085852ff6dd28cf1fcace99332def 100644 (file)
@@ -399,11 +399,14 @@ is done).
 
 Attribute assignment update the module's name space dictionary.
 
-Special read-only attributes: \verb@__dict__@ yields the module's name
-space as a dictionary object; \verb@__name__@ yields the module's name
-as a string object.
+Special read-only attribute: \verb@__dict__@ yields the module's name
+space as a dictionary object.  Predefined attributes: \verb@__name__@
+yields the module's name as a string object; \verb@__doc__@ yields the
+module's documentation string as a string object, or
+\verb@None@ if no documentation string was found.
 \ttindex{__dict__}
 \ttindex{__name__}
+\ttindex{__doc__}
 \indexii{module}{name space}
 
 \item[Classes]
index 60af2dc94a0eeb63cb1654e639358018307c27b1..e017e263336085852ff6dd28cf1fcace99332def 100644 (file)
@@ -399,11 +399,14 @@ is done).
 
 Attribute assignment update the module's name space dictionary.
 
-Special read-only attributes: \verb@__dict__@ yields the module's name
-space as a dictionary object; \verb@__name__@ yields the module's name
-as a string object.
+Special read-only attribute: \verb@__dict__@ yields the module's name
+space as a dictionary object.  Predefined attributes: \verb@__name__@
+yields the module's name as a string object; \verb@__doc__@ yields the
+module's documentation string as a string object, or
+\verb@None@ if no documentation string was found.
 \ttindex{__dict__}
 \ttindex{__name__}
+\ttindex{__doc__}
 \indexii{module}{name space}
 
 \item[Classes]