Anonymous avatar Anonymous committed 76e5f35

Added __doc__ to predefined module attributes.

Comments (0)

Files changed (2)

 
 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]
 
 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]
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.