summaryrefslogtreecommitdiff
path: root/docutils/docs/dev/semantics.txt
diff options
context:
space:
mode:
author(no author) <(no author)@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-05-01 02:53:07 +0000
committer(no author) <(no author)@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-05-01 02:53:07 +0000
commit9e0c8b3997b83945c58c5ede77278f205b97d03e (patch)
tree5fdea7c382ce0fdcc49bc2bc0f9e8faaa7f4effc /docutils/docs/dev/semantics.txt
parent6a5511292419427c9a4c9258b71c47d072a02878 (diff)
downloaddocutils-tibs.tar.gz
This commit was manufactured by cvs2svn to create branch 'tibs'.tibs
git-svn-id: http://svn.code.sf.net/p/docutils/code/branches/tibs@63 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev/semantics.txt')
-rw-r--r--docutils/docs/dev/semantics.txt47
1 files changed, 0 insertions, 47 deletions
diff --git a/docutils/docs/dev/semantics.txt b/docutils/docs/dev/semantics.txt
deleted file mode 100644
index f6ec09ebd..000000000
--- a/docutils/docs/dev/semantics.txt
+++ /dev/null
@@ -1,47 +0,0 @@
-=====================
- Docstring Semantics
-=====================
-:Author: David Goodger
-:Contact: goodger@users.sourceforge.net
-:Revision: $Revision$
-:Date: $Date$
-
-These are notes for a possible future PEP providing the final piece of
-the Python docstring puzzle.
-
-PythonDoc
-=========
-
-A Python version of the JavaDoc semantics (not syntax). A set of
-conventions which are understood by the Docutils.
-
-- Can we extract comments from parsed modules? Could be handy for
- documenting function/method parameters::
-
- def method(self,
- source, # path of input file
- dest # path of output file
- ):
-
- This would save having to repeat parameter names in the docstring.
-
- Idea from Mark Hammond's 1998-06-23 Doc-SIG post, "Re: [Doc-SIG]
- Documentation tool":
-
- it would be quite hard to add a new param to this method without
- realising you should document it
-
-- Use field lists or definition lists for "tagged blocks".
-
-- Frederic Giacometti's "iPhrase Python documentation conventions" is
- an attachment to his Doc-SIG post of 2001-05-30
- (http://mail.python.org/pipermail/doc-sig/2001-May/001840.html).
-
-
-..
- Local Variables:
- mode: indented-text
- indent-tabs-mode: nil
- sentence-end-double-space: t
- fill-column: 70
- End: