summaryrefslogtreecommitdiff
path: root/docs/dev/pysource.txt
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2003-01-10 02:25:51 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2003-01-10 02:25:51 +0000
commit13681f75fbe4e198808988aa4dc962524e89fbcf (patch)
tree9e3c7640630458e4f20f2e32d9352f28ab1bca75 /docs/dev/pysource.txt
parent1f393658c70d96fdad22e213721531c2e1553bc5 (diff)
downloaddocutils-13681f75fbe4e198808988aa4dc962524e89fbcf.tar.gz
updated
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@1090 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/dev/pysource.txt')
-rw-r--r--docs/dev/pysource.txt41
1 files changed, 0 insertions, 41 deletions
diff --git a/docs/dev/pysource.txt b/docs/dev/pysource.txt
index 1b5e629f7..e1df7fb52 100644
--- a/docs/dev/pysource.txt
+++ b/docs/dev/pysource.txt
@@ -105,47 +105,6 @@ DTD elements: package, module, class, method, function,
module_attribute, class_attribute, instance_attribute, variable,
parameter, type, exception_class, warning_class.
-In Python docstrings, interpreted text is used to classify and mark up
-program identifiers, such as the names of variables, functions,
-classes, and modules. If the identifier alone is given, its role is
-inferred implicitly according to the Python namespace lookup rules.
-For functions and methods (even when dynamically assigned),
-parentheses ('()') may be included::
-
- This function uses `another()` to do its work.
-
-For class, instance and module attributes, dotted identifiers are used
-when necessary::
-
- class Keeper(Storer):
-
- """
- Extend `Storer`. Class attribute `instances` keeps track of
- the number of `Keeper` objects instantiated.
- """
-
- instances = 0
- """How many `Keeper` objects are there?"""
-
- def __init__(self):
- """
- Extend `Storer.__init__()` to keep track of instances.
-
- Keep count in `self.instances` and data in `self.data`.
- """
- Storer.__init__(self)
- self.instances += 1
-
- self.data = []
- """Store data in a list, most recent last."""
-
- def storedata(self, data):
- """
- Extend `Storer.storedata()`; append new `data` to a list
- (in `self.data`).
- """
- self.data = data
-
To classify identifiers explicitly, the role is given along with the
identifier in either prefix or suffix form::