docstring-checkins Mailing List for Docstring Processing System (Page 18)
Status: Pre-Alpha
Brought to you by:
goodger
Menu
▾
▴
docstring-checkins — CVS checkin messages
You can subscribe to this list here.
| 2001 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
(53) |
Sep
(54) |
Oct
(26) |
Nov
(27) |
Dec
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2002 |
Jan
(60) |
Feb
(85) |
Mar
(94) |
Apr
(40) |
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|
From: David G. <go...@us...> - 2001-08-14 03:55:00
|
Update of /cvsroot/docstring/dps
In directory usw-pr-cvs1:/tmp/cvs-serv609/dps
Modified Files:
HISTORY.txt
Log Message:
updated
Index: HISTORY.txt
===================================================================
RCS file: /cvsroot/docstring/dps/HISTORY.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** HISTORY.txt 2001/08/11 01:53:18 1.3
--- HISTORY.txt 2001/08/14 03:54:58 1.4
***************
*** 64,68 ****
- Added names to system warnings.
! * spec/gdpi.dtd: Fixed typos & omissions; now validates.
* spec/pdpi.dtd: Fixed typos; now validates.
--- 64,71 ----
- Added names to system warnings.
! * spec/gdpi.dtd:
!
! - Fixed typos & omissions; now validates.
! - Changed field_argument's model to PCDATA.
* spec/pdpi.dtd: Fixed typos; now validates.
|
|
From: David G. <go...@us...> - 2001-08-14 03:52:32
|
Update of /cvsroot/docstring/dps/spec In directory usw-pr-cvs1:/tmp/cvs-serv32672/dps/spec Modified Files: gpdi.dtd Log Message: - Changed field_argument's model to PCDATA. Index: gpdi.dtd =================================================================== RCS file: /cvsroot/docstring/dps/spec/gpdi.dtd,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** gpdi.dtd 2001/07/27 04:07:56 1.4 --- gpdi.dtd 2001/08/14 03:52:29 1.5 *************** *** 251,255 **** <!-- Support for Javadoc-style tags with arguments. --> ! <!ELEMENT field_argument %text.model;> <!ATTLIST field_argument %basic.atts;> --- 251,255 ---- <!-- Support for Javadoc-style tags with arguments. --> ! <!ELEMENT field_argument (#PCDATA)> <!ATTLIST field_argument %basic.atts;> |
|
From: David G. <go...@us...> - 2001-08-11 01:58:18
|
Update of /cvsroot/docstring/dps/dps
In directory usw-pr-cvs1:/tmp/cvs-serv32354/dps/dps
Modified Files:
statemachine.py
Log Message:
- Fixed bug in StateMachineWS.getknownindented() that caused it to return a list containing one empty string.
Index: statemachine.py
===================================================================
RCS file: /cvsroot/docstring/dps/dps/statemachine.py,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** statemachine.py 2001/07/22 22:36:03 1.1.1.1
--- statemachine.py 2001/08/11 01:58:15 1.2
***************
*** 725,729 ****
"""
offset = self.abslineoffset()
! indented = [self.line[indent:]]
for line in self.inputlines[self.lineoffset + 1:]:
if line[:indent].strip():
--- 725,732 ----
"""
offset = self.abslineoffset()
! if self.line[indent:]:
! indented = [self.line[indent:]]
! else:
! indented = []
for line in self.inputlines[self.lineoffset + 1:]:
if line[:indent].strip():
***************
*** 733,737 ****
else:
blankfinish = 1
! self.nextline(len(indented) - 1) # advance to last indented line
while indented and not indented[-1].strip():
indented.pop()
--- 736,741 ----
else:
blankfinish = 1
! if indented:
! self.nextline(len(indented) - 1) # advance to last indented line
while indented and not indented[-1].strip():
indented.pop()
|
|
From: David G. <go...@us...> - 2001-08-11 01:53:32
|
Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv31791/dps/spec
Modified Files:
dps-notes.txt
Log Message:
updated
Index: dps-notes.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/dps-notes.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** dps-notes.txt 2001/08/06 04:32:20 1.4
--- dps-notes.txt 2001/08/11 01:53:29 1.5
***************
*** 17,21 ****
- PEP 256: Draw the framework diagram properly as a graphic (once PEPs
! support inline graphics !-).
- Document!
--- 17,21 ----
- PEP 256: Draw the framework diagram properly as a graphic (once PEPs
! support graphics !-).
- Document!
***************
*** 33,36 ****
--- 33,42 ----
'Suggestions for reST "modes"' as a base.
+ - Ask Python-dev for opinions (GvR for a pronouncement) on special
+ variables (__author__, __version__, etc.): convenience vs. namespace
+ pollution. Ask opinions on whether or not the DPS should recognize &
+ use them.
+
+
Error Handling
==============
***************
*** 59,62 ****
--- 65,69 ----
.. _VMS severity levels:
http://www.openvms.compaq.com:8000/73final/5841/5841pro_027.html#error_cond_severity
+
I/O APIs
|
|
From: David G. <go...@us...> - 2001-08-11 01:53:21
|
Update of /cvsroot/docstring/dps In directory usw-pr-cvs1:/tmp/cvs-serv31766/dps Modified Files: HISTORY.txt Log Message: updated Index: HISTORY.txt =================================================================== RCS file: /cvsroot/docstring/dps/HISTORY.txt,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** HISTORY.txt 2001/07/29 15:55:48 1.2 --- HISTORY.txt 2001/08/11 01:53:18 1.3 *************** *** 9,15 **** --- 9,67 ---- + Acknowledgements + ================ + + I would like to acknowledge the people who have made a direct impact + on the Python Docstring Processing System project, knowingly or not, + in terms of encouragement, suggestions, criticism, bug reports, code + contributions, and related projects: + + David Ascher, Fred Drake, Jim Fulton, Peter Funk, Doug Hellmann, + Juergen Hermann, Tony Ibbs, Garth Kidd, Daniel Larsson, Marc-Andre + Lemburg, Wolfgang Lipp, Edward Loper, Ken Manheimer, Michel + Pelletier, Sam Penrose, Tim Peters, Mark Pilgrim, Tavis Rudd, Bob + Tolbert, Laurence Tratt, Guido van Rossum, Barry Warsaw, Edward + Welbourne, Ka-Ping Yee, Moshe Zadka + + (I'm still waiting for contributions of tasty snacks, computer + equipment, and cold hard cash. :-) Hopefully I haven't forgotten + anyone or misspelled any names; apologies (and please let me know!) if + I have. + + Release 0.4? (pending) ======================== + * install.py: Added to project. + + * setup.py: Modified for import by install.py. + + * dps/roman.py: Added to project. Written by and courtesy of Mark + Pilgrim. From http://diveintopython.org. + + * dps/statemachine.py: + + - Fixed bug in StateMachineWS.getknownindented(). + + * dps/parsers/model.py: + + - Added setup_parse() so unoverridden parse() could raise a + NotImplementedError. + + * spec/pep-0256.txt: + + - Added ref to Ed Loper's STminus. + - Added "methods" to abstract. + + * spec/pep-0257.txt: + + - Added "methods" to descriptions. + - Mentioned Unicode strings. + + * spec/pep-0258.txt: + + - Clarifications due to Tony Ibbs. + - Added names to system warnings. + * spec/gdpi.dtd: Fixed typos & omissions; now validates. *************** *** 99,123 **** The project web site and the first project release were rolled out. Candidate PEPs posted to Doc-SIG 2001-06-03. - - - Acknowledgements - ================ - - I would like to acknowledge the people who have made a direct impact - on the Python Docstring Processing System project, knowingly or not, - in terms of encouragement, suggestions, criticism, bug reports, code - contributions, and related projects: - - David Ascher, Fred Drake, Jim Fulton, Peter Funk, Doug Hellmann, - Juergen Hermann, Tony Ibbs, Garth Kidd, Daniel Larsson, Marc-Andre - Lemburg, Wolfgang Lipp, Edward Loper, Ken Manheimer, Michel - Pelletier, Sam Penrose, Tim Peters, Tavis Rudd, Bob Tolbert, - Laurence Tratt, Guido van Rossum, Barry Warsaw, Edward Welbourne, - Ka-Ping Yee, Moshe Zadka - - (I'm still waiting for contributions of tasty snacks, computer - equipment, and cold hard cash. :-) Hopefully I haven't forgotten - anyone or misspelled any names; apologies (and please let me know!) if - I have. --- 151,154 ---- |
|
From: David G. <go...@us...> - 2001-08-11 01:52:51
|
Update of /cvsroot/docstring/dps/dps In directory usw-pr-cvs1:/tmp/cvs-serv31701/dps/dps Added Files: roman.py Log Message: courtesy of Mark Pilgrim, http://diveintopython.org --- NEW FILE: roman.py --- """Convert to and from Roman numerals""" __author__ = "Mark Pilgrim (f8...@di...)" __version__ = "1.4" __date__ = "8 August 2001" __copyright__ = """Copyright (c) 2001 Mark Pilgrim This program is part of "Dive Into Python", a free Python tutorial for experienced programmers. Visit http://diveintopython.org/ for the latest version. This program is free software; you can redistribute it and/or modify it under the terms of the Python 2.1.1 license, available at http://www.python.org/2.1.1/license.html """ import re #Define exceptions class RomanError(Exception): pass class OutOfRangeError(RomanError): pass class NotIntegerError(RomanError): pass class InvalidRomanNumeralError(RomanError): pass #Define digit mapping romanNumeralMap = (('M', 1000), ('CM', 900), ('D', 500), ('CD', 400), ('C', 100), ('XC', 90), ('L', 50), ('XL', 40), ('X', 10), ('IX', 9), ('V', 5), ('IV', 4), ('I', 1)) def toRoman(n): """convert integer to Roman numeral""" if not (0 < n < 5000): raise OutOfRangeError, "number out of range (must be 1..4999)" if int(n) <> n: raise NotIntegerError, "decimals can not be converted" result = "" for numeral, integer in romanNumeralMap: while n >= integer: result += numeral n -= integer return result #Define pattern to detect valid Roman numerals romanNumeralPattern = re.compile(''' ^ # beginning of string M{0,4} # thousands - 0 to 4 M's (CM|CD|D?C{0,3}) # hundreds - 900 (CM), 400 (CD), 0-300 (0 to 3 C's), # or 500-800 (D, followed by 0 to 3 C's) (XC|XL|L?X{0,3}) # tens - 90 (XC), 40 (XL), 0-30 (0 to 3 X's), # or 50-80 (L, followed by 0 to 3 X's) (IX|IV|V?I{0,3}) # ones - 9 (IX), 4 (IV), 0-3 (0 to 3 I's), # or 5-8 (V, followed by 0 to 3 I's) $ # end of string ''' ,re.VERBOSE) def fromRoman(s): """convert Roman numeral to integer""" if not s: raise InvalidRomanNumeralError, 'Input can not be blank' if not romanNumeralPattern.search(s): raise InvalidRomanNumeralError, 'Invalid Roman numeral: %s' % s result = 0 index = 0 for numeral, integer in romanNumeralMap: while s[index:index+len(numeral)] == numeral: result += integer index += len(numeral) return result |
|
From: David G. <go...@us...> - 2001-08-06 04:32:23
|
Update of /cvsroot/docstring/dps/spec In directory usw-pr-cvs1:/tmp/cvs-serv27638/dps/spec Modified Files: dps-notes.txt Log Message: modes Index: dps-notes.txt =================================================================== RCS file: /cvsroot/docstring/dps/spec/dps-notes.txt,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** dps-notes.txt 2001/08/04 15:25:52 1.3 --- dps-notes.txt 2001/08/06 04:32:20 1.4 *************** *** 30,33 **** --- 30,35 ---- - Add validation? See http://pytrex.sourceforge.net, RELAX NG. + - Incorporate "modes", using Tony Ibbs' 2001-08-03 Doc-SIG post + 'Suggestions for reST "modes"' as a base. Error Handling |
|
From: David G. <go...@us...> - 2001-08-04 15:45:45
|
Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv19455/dps/spec
Modified Files:
pep-0257.txt
Log Message:
added "methods" to descriptions, Unicode strings
Index: pep-0257.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/pep-0257.txt,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** pep-0257.txt 2001/07/22 22:36:21 1.1.1.1
--- pep-0257.txt 2001/08/04 15:45:43 1.2
***************
*** 71,75 ****
For consistency, always use """triple double quotes""" around
docstrings. Use r"""raw triple double quotes""" if you use any
! backslashes in your docstrings.
There are two forms of docstrings: one-liners and multi-line
--- 71,76 ----
For consistency, always use """triple double quotes""" around
docstrings. Use r"""raw triple double quotes""" if you use any
! backslashes in your docstrings. For Unicode docstrings, use
! u"""Unicode triple-quoted strings""".
There are two forms of docstrings: one-liners and multi-line
***************
*** 99,107 ****
- The docstring is a phrase ending in a period. It prescribes the
! function's effect as a command ("Do this", "Return that"), not
! as a description: e.g. don't write "Returns the pathname ..."
- The one-line docstring should NOT be a "signature" reiterating
! the function parameters (which can be obtained by
introspection). Don't do::
--- 100,109 ----
- The docstring is a phrase ending in a period. It prescribes the
! function or method's effect as a command ("Do this", "Return
! that"), not as a description: e.g. don't write "Returns the
! pathname ..."
- The one-line docstring should NOT be a "signature" reiterating
! the function/method parameters (which can be obtained by
introspection). Don't do::
***************
*** 133,141 ****
line, and the docstring needs to be offset from the first method
by a blank line; for symmetry, put a blank line between the class
! header and the docstring. Docstrings documenting functions
! generally don't have this requirement, unless the function's body
! is written as a number of blank-line separated sections -- in this
! case, treat the docstring as another section, and precede it with
! a blank line.
The docstring of a script (a stand-alone program) should be usable
--- 135,143 ----
line, and the docstring needs to be offset from the first method
by a blank line; for symmetry, put a blank line between the class
! header and the docstring. Docstrings documenting functions or
! methods generally don't have this requirement, unless the function
! or method's body is written as a number of blank-line separated
! sections -- in this case, treat the docstring as another section,
! and precede it with a blank line.
The docstring of a script (a stand-alone program) should be usable
|
|
From: David G. <go...@us...> - 2001-08-04 15:44:52
|
Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv19164/dps/spec
Modified Files:
pep-0256.txt
Log Message:
added ref to Ed Loper's STminus; added "methods" to abstract
Index: pep-0256.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/pep-0256.txt,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** pep-0256.txt 2001/07/22 22:36:18 1.1.1.1
--- pep-0256.txt 2001/08/04 15:44:49 1.2
***************
*** 13,22 ****
Abstract
! Python modules, classes and functions have a string attribute
! called __doc__. If the first expression inside the definition is
! a literal string, that string is assigned to the __doc__
! attribute, called a documentation string or docstring. It is
! often used to summarize the interface of the module, class or
! function.
There is no standard format (markup) for docstrings, nor are there
--- 13,22 ----
Abstract
! Python modules, functions, classes and methods have a string
! attribute called __doc__. If the first expression inside their
! definition is a literal string, that string is assigned to the
! __doc__ attribute, called a documentation string or docstring. It
! is often used to summarize the interface of the module, function,
! class or method.
There is no standard format (markup) for docstrings, nor are there
***************
*** 71,74 ****
--- 71,76 ----
- Tony Ibbs' docutils [7]
+ - Edward Loper's STminus formalization and related efforts [8]
+
These systems, each with different goals, have had varying degrees
of success. A problem with many of the above systems was
***************
*** 80,84 ****
Throughout the existence of the Python Documentation Special
! Interest Group (Doc-SIG) [8], consensus on a single standard
docstring format has never been reached. A lightweight, implicit
markup has been sought, for the following reasons (among others):
--- 82,86 ----
Throughout the existence of the Python Documentation Special
! Interest Group (Doc-SIG) [9], consensus on a single standard
docstring format has never been reached. A lightweight, implicit
markup has been sought, for the following reasons (among others):
***************
*** 99,104 ****
minimalist Python syntax.
! Early on, variants of Setext (Structure Enhanced Text) [9],
! including Digital Creation's StructuredText [10], were proposed
for Python docstring formatting. Hereafter we will collectively
call these variants 'STexts'. Although used by some (including in
--- 101,106 ----
minimalist Python syntax.
! Early on, variants of Setext (Structure Enhanced Text) [10],
! including Digital Creation's StructuredText [11], were proposed
for Python docstring formatting. Hereafter we will collectively
call these variants 'STexts'. Although used by some (including in
***************
*** 181,185 ****
- First line is a one-line synopsis.
! PEP 257, Docstring Conventions [11], documents these issues.
2. Docstring processing system generic implementation details.
--- 183,187 ----
- First line is a one-line synopsis.
! PEP 257, Docstring Conventions [12], documents these issues.
2. Docstring processing system generic implementation details.
***************
*** 205,209 ****
These issues are applicable to any docstring processing system
implementation. PEP 258, DPS Generic Implementation Details
! [12], documents these issues.
3. Docstring processing system implementation.
--- 207,211 ----
These issues are applicable to any docstring processing system
implementation. PEP 258, DPS Generic Implementation Details
! [13], documents these issues.
3. Docstring processing system implementation.
***************
*** 276,292 ****
[7] http://homepage.ntlworld.com/tibsnjoan/docutils/
! [8] http://www.python.org/sigs/doc-sig/
! [9] http://www.bsdi.com/setext/
! [10] http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
! [11] PEP 257, Docstring Conventions, Goodger, Van Rossum
http://www.python.org/peps/pep-0257.html
! [12] PEP 258, DPS Generic Implementation Details, Goodger
http://www.python.org/peps/pep-0258.html
! [13] PEP 216, Docstring Format, Zadka
http://www.python.org/peps/pep-0216.html
--- 278,296 ----
[7] http://homepage.ntlworld.com/tibsnjoan/docutils/
! [8] http://www.cis.upenn.edu/~edloper/pydoc/
! [9] http://www.python.org/sigs/doc-sig/
! [10] http://www.bsdi.com/setext/
! [11] http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
!
! [12] PEP 257, Docstring Conventions, Goodger, Van Rossum
http://www.python.org/peps/pep-0257.html
! [13] PEP 258, DPS Generic Implementation Details, Goodger
http://www.python.org/peps/pep-0258.html
! [14] PEP 216, Docstring Format, Zadka
http://www.python.org/peps/pep-0216.html
***************
*** 301,305 ****
This document borrows text from PEP 216, Docstring Format, by
! Moshe Zadka [13]. It is intended as a reorganization of PEP 216
and its approach.
--- 305,309 ----
This document borrows text from PEP 216, Docstring Format, by
! Moshe Zadka [14]. It is intended as a reorganization of PEP 216
and its approach.
|
|
From: David G. <go...@us...> - 2001-08-04 15:43:36
|
Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv18949/dps/spec
Modified Files:
pep-0258.txt
Log Message:
clarifications due to Tony Ibbs; added names to system warnings
Index: pep-0258.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/pep-0258.txt,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** pep-0258.txt 2001/07/22 22:36:26 1.1.1.1
--- pep-0258.txt 2001/08/04 15:43:33 1.2
***************
*** 45,51 ****
in the following places within Python modules:
! a) At the beginning of a module, class definition, or function
! definition, after any comments. This is the standard for
! Python __doc__ attributes.
b) Immediately following a simple assignment at the top level
--- 45,51 ----
in the following places within Python modules:
! a) At the beginning of a module, function definition, class
! definition, or method definition, after any comments. This
! is the standard for Python __doc__ attributes.
b) Immediately following a simple assignment at the top level
***************
*** 66,70 ****
string literal expressions (2b and 2c above), meaning importing
the module will lose these docstrings. Of course, standard
! Python parsing tools such as the 'parser' library module should
be used.
--- 66,70 ----
string literal expressions (2b and 2c above), meaning importing
the module will lose these docstrings. Of course, standard
! Python parsing tools such as the 'parser' library module may
be used.
***************
*** 167,172 ****
Issue: This breaks 'from __future__ import' statements in Python
! 2.1 for multiple module docstrings. Resolution?
1. Should we search for docstrings after a __future__ statement?
Very ugly.
--- 167,183 ----
Issue: This breaks 'from __future__ import' statements in Python
! 2.1 for multiple module docstrings. The Python Reference Manual
! specifies:
!
! A future statement must appear near the top of the module. The
! only lines that can appear before a future statement are:
!
! * the module docstring (if any),
! * comments,
! * blank lines, and
! * other future statements.
+ Resolution?
+
1. Should we search for docstrings after a __future__ statement?
Very ugly.
***************
*** 296,304 ****
===========================
! A single intermediate data structure is used internally by the
! docstring processing system. This data structure is a DOM tree
! (or equivalent) whose schema is documented in an XML DTD
! (eXtensible Markup Language Document Type Definition), which comes
! in three parts:
- the Python Plaintext Document Interface DTD, ppdi.dtd [6],
--- 307,317 ----
===========================
! A single intermediate data structure is used by the docstring
! processing system, in the interfaces between parsers, the DPS
! itself, and formatters. It is not required that this data
! structure be used internally by any of the componentes. This data
! structure is similar to a DOM tree whose schema is documented in
! an XML DTD (eXtensible Markup Language Document Type Definition),
! which comes in three parts:
- the Python Plaintext Document Interface DTD, ppdi.dtd [6],
***************
*** 326,332 ****
File/directory naming & structure conventions. In-memory data
structure should follow filesystem naming; file/directory ==
! leaf/node. Use a directory hierarchy rather than long file names
! (long file names were one of the reasons pythondoc couldn't run on
! MacOS).
Error Handling
--- 339,347 ----
File/directory naming & structure conventions. In-memory data
structure should follow filesystem naming; file/directory ==
! leaf/node. Use a directory hierarchy rather than long file names.
! (The files generated by pythondoc used compound file names, like
! 'packagename.modulename.classname.html', which were often too long
! for the 38-character MacOS file name length limit. This is one of
! the reasons pythondoc couldn't run on MacOS).
Error Handling
***************
*** 334,354 ****
When the parser encounters an error in markup, it inserts a system
! warning (DTD element 'system_warning'). There are four levels of
system warnings:
! - Level-0: A minor issue that can be ignored. There is no effect
! on the processing. Typically level-0 system warnings are not
! reported.
! - Level-1: An issue that should be addressed. If ignored, there
! may be minor problems with the output.
! - Level-2: An issue that should be addressed. If ignored, there
! may be significant problems with the output.
! - Level-3: A major issue that must be addressed. Typically level-3
! system warnings are turned into exceptions which halt
! processing. If ignored, the output will have significant
! problems.
--- 349,369 ----
When the parser encounters an error in markup, it inserts a system
! warning (DTD element 'system_warning'). There are four levels of
system warnings:
! - Level-0, "information": A minor issue that can be ignored.
! There is no effect on the processing. Typically level-0 system
! warnings are not reported.
! - Level-1, "warning": An issue that should be addressed. If
! ignored, there may be unpredictable problems with the output.
! - Level-2, "error": An error that should be addressed. If
! ignored, the output will contain errors.
! - Level-3, "severe": A severe error that must be addressed.
! Typically level-3 system warnings are turned into exceptions
! which halt processing. If ignored, the output will contain
! severe errors.
***************
*** 368,376 ****
[5] http://lcweb.loc.gov/standards/iso639-2/englangn.html
! [6] http://docstring.sf.net/spec/ppdi.dtd
! [7] http://docstring.sf.net/spec/gpdi.dtd
! [8] http://docstring.sf.net/spec/soextblx.dtd
[9] http://www.python.org/sigs/doc-sig/
--- 383,391 ----
[5] http://lcweb.loc.gov/standards/iso639-2/englangn.html
! [6] http://docstring.sourceforge.net/spec/ppdi.dtd
! [7] http://docstring.sourceforge.net/spec/gpdi.dtd
! [8] http://docstring.sourceforge.net/spec/soextblx.dtd
[9] http://www.python.org/sigs/doc-sig/
***************
*** 380,384 ****
A SourceForge project has been set up for this work at
! http://docstring.sf.net.
--- 395,399 ----
A SourceForge project has been set up for this work at
! http://docstring.sourceforge.net.
|
|
From: David G. <go...@us...> - 2001-08-04 15:25:56
|
Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv15942/dps/spec
Modified Files:
dps-notes.txt
Log Message:
added system warning names from VMS
Index: dps-notes.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/dps-notes.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** dps-notes.txt 2001/08/01 02:46:47 1.2
--- dps-notes.txt 2001/08/04 15:25:52 1.3
***************
*** 13,19 ****
- Fill in the blanks in API details.
! - Rework PEP 257, separating style from spec wrt DPS. See Doc-SIG
! from 2001-06-19/20.
- Document!
--- 13,22 ----
- Fill in the blanks in API details.
! - Rework PEP 257, separating style from spec from tools, wrt DPS. See
! Doc-SIG from 2001-06-19/20.
+ - PEP 256: Draw the framework diagram properly as a graphic (once PEPs
+ support inline graphics !-).
+
- Document!
***************
*** 25,30 ****
- Add layout component to framework? Or part of the formatter?
! - Add validation? See http://pytrex.sf.net, RELAX NG.
I/O APIs
--- 28,60 ----
- Add layout component to framework? Or part of the formatter?
! - Add validation? See http://pytrex.sourceforge.net, RELAX NG.
!
!
! Error Handling
! ==============
!
! Tibs pointed out that the four levels correspond to `VMS severity levels`_:
!
! +-------+-------+--------------+------------------------------------+
! | DPS | VMS | | |
! | Level | Value | Severity | Response |
! +=======+=======+==============+====================================+
! | n/a | 1 | Success | Execution continues, expected |
! | | | | results |
! +-------+-------+--------------+------------------------------------+
! | 0 | 3 | Information | Execution continues, informational |
! | | | | message displayed |
! +-------+-------+--------------+------------------------------------+
! | 1 | 0 | Warning | Execution continues, unpredictable |
! | | | | results |
! +-------+-------+--------------+------------------------------------+
! | 2 | 2 | Error | Execution continues, erroneous |
! | | | | results |
! +-------+-------+--------------+------------------------------------+
! | 3 | 4 | Severe error | Execution terminates, no output |
! +-------+-------+--------------+------------------------------------+
+ .. _VMS severity levels:
+ http://www.openvms.compaq.com:8000/73final/5841/5841pro_027.html#error_cond_severity
I/O APIs
|
|
From: David G. <go...@us...> - 2001-08-04 15:08:29
|
Update of /cvsroot/docstring/web In directory usw-pr-cvs1:/tmp/cvs-serv12427/web Modified Files: index.html.template Log Message: updates Index: index.html.template =================================================================== RCS file: /cvsroot/docstring/web/index.html.template,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** index.html.template 2001/07/22 22:42:01 1.1 --- index.html.template 2001/08/04 15:08:25 1.2 *************** *** 8,14 **** <BODY bgcolor="#F0F0FF"> ! <P><A HREF="http://sf.net/projects/docstring/"> ! <IMG SRC="title.png" ALT="Docstring Processing System" BORDER=0 ALIGN=bottom> ! </A></P> <P><I>last updated: `date`</I></P> --- 8,14 ---- <BODY bgcolor="#F0F0FF"> ! <P><A HREF="http://sourceforge.net/projects/docstring/" ! ><IMG SRC="title.png" ! ALT="Docstring Processing System" BORDER=0 ALIGN=bottom></A></P> <P><I>last updated: `date`</I></P> *************** *** 18,21 **** --- 18,50 ---- modules and converting it into useful formats, such as HTML, XML, and TeX.</P> + <H2>Project Status</H2> + + <P>This project consists of a Python package, “<TT>dps</TT>”. This + contains utility modules and three subpackages, <TT>dps.parsers</TT>, + <TT>dps.formatters</TT>, and <TT>dps.languages</TT>. Each of the subpackages + will contain further modules or packages implementing individual + components.</P> + + <P>Good progress is being made with regards to the parser interface. The <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/dps/statemachine.py?rcontent-type=text/plain" + ><TT>dps.statemachine</TT></A> module is useful for line-based parsing of + input text using regular expressions, and is being used by the <A + HREF="http://structuredtext.sourceforge.net/" >reStructuredText</A> input + parser.</P> + + <P>The <A + HREF="http://prdownloads.sourceforge.net/docstring/`latest_dps_release`" + >latest project release package (`latest_dps_release`)</A> and past project + releases can be downloaded from the <A + HREF="http://sourceforge.net/project/showfiles.php?group_id=26626" >project files + page</A>. <A HREF="http://sourceforge.net/cvs/?group_id=26626">Anonymous CVS + access is available.</A> You can also <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/" + >browse the latest source files (CVS) individually</A>, and read the latest <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/README.txt?rcontent-type=text/plain" + >README.txt</A> and <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/HISTORY.txt?rcontent-type=text/plain" + >HISTORY.txt</A>.</P> + <H2>Specification</H2> *************** *** 25,31 **** files are included in the <A HREF="http://prdownloads.sourceforge.net/docstring/`latest_dps_release`">latest ! project release package (`latest_dps_release`)</A>, or they can be accessed individually below. Note that some of the individual files below may be newer ! than those included in the latest project release package.</P> <UL> --- 54,63 ---- files are included in the <A HREF="http://prdownloads.sourceforge.net/docstring/`latest_dps_release`">latest ! project release package (`latest_dps_release`)</A> (which may not be up to ! date). The up-to-date working documents (from CVS) may be accessed individually below. Note that some of the individual files below may be newer ! than those included in the latest project release package. You can also <A ! HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/spec/" ! >browse the CVS repository</A> directly.</P> <UL> *************** *** 36,43 **** <LI><P><A HREF="`path`/`file`"> `fields['title']`</A> - <BR>`info` #> if fields.has_key('pep'): # havePEPs = 1 ! [<A HREF="http://www.python.org/peps/pep-`('0000%s' % fields['pep'])[-4:]`.html" >PEP `fields['pep']` in master repository</A>]<A HREF="#master">*</A> #< --- 68,74 ---- <LI><P><A HREF="`path`/`file`"> `fields['title']`</A> #> if fields.has_key('pep'): # havePEPs = 1 ! <BR>[<A HREF="http://www.python.org/peps/pep-`('0000%s' % fields['pep'])[-4:]`.html" >PEP `fields['pep']` in master repository</A>]<A HREF="#master">*</A> #< *************** *** 53,80 **** #< - <H2>Project Status</H2> - - <P>This project consists of a Python package, "<TT>dps</TT>". This contains - utility modules and three subpackages, <TT>dps.parsers</TT>, - <TT>dps.formatters</TT>, and <TT>dps.languages</TT>. Each of the - subpackages will contain further modules or packages implementing - individual components.</P> - - <P>Good progress is being made with regards to the parser interface. The <A - HREF="dps/statemachine.py"><TT>dps.statemachine</TT></A> module is useful for - line-based parsing of input text using regular expressions, and is being used - by the <A HREF="http://structuredtext.sf.net/">reStructuredText</A> input - parser.</P> - - <P>The <A - HREF="http://prdownloads.sourceforge.net/docstring/`latest_dps_release`">latest - project release package (`latest_dps_release`)</A> and past project releases - can be downloaded from the <A - HREF="http://sf.net/project/showfiles.php?group_id=26626">project files - page</A>. You can also <A HREF="http://docstring.sf.net/dps/">browse the - latest source files</A> individually, and read the latest <A - HREF="http://docstring.sf.net/README.txt">README.txt</A> and <A - HREF="http://docstring.sf.net/HISTORY.txt">HISTORY.txt</A>.</P> - <H2>Components</H2> --- 84,87 ---- *************** *** 86,90 **** <LI><P> ! <A HREF="http://structuredtext.sf.net/">reStructuredText</A> input parser </P></LI> --- 93,97 ---- <LI><P> ! <A HREF="http://structuredtext.sourceforge.net/">reStructuredText</A> </P></LI> *************** *** 137,142 **** <UL> ! <LI><P><A HREF="http://sf.net/projects/docstring/">Python Docstring Processing System project page</A></P></LI> <LI><P>Project administrator: --- 144,154 ---- <UL> ! <LI><P>Bug reports, patches, feature requests, mailing lists, news: <A ! HREF="http://sourceforge.net/projects/docstring/" >Python Docstring Processing System project page</A></P></LI> + + <LI><P><A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/" + >Docstring Processing System CVS repository</A></P></LI> <LI><P>Project administrator: |
|
From: David G. <go...@us...> - 2001-08-04 15:08:16
|
Update of /cvsroot/docstring/web In directory usw-pr-cvs1:/tmp/cvs-serv12370/web Modified Files: index.html Log Message: updates Index: index.html =================================================================== RCS file: /cvsroot/docstring/web/index.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** index.html 2001/07/22 22:41:50 1.1 --- index.html 2001/08/04 15:08:13 1.2 *************** *** 7,15 **** <BODY bgcolor="#F0F0FF"> ! <P><A HREF="http://sf.net/projects/docstring/"> ! <IMG SRC="title.png" ALT="Docstring Processing System" BORDER=0 ALIGN=bottom> ! </A></P> ! <P><I>last updated: 2001-07-20</I></P> <P>The purpose of the Python Docstring Processing System project is to create --- 7,15 ---- <BODY bgcolor="#F0F0FF"> ! <P><A HREF="http://sourceforge.net/projects/docstring/" ! ><IMG SRC="title.png" ! ALT="Docstring Processing System" BORDER=0 ALIGN=bottom></A></P> ! <P><I>last updated: 2001-08-03</I></P> <P>The purpose of the Python Docstring Processing System project is to create *************** *** 17,20 **** --- 17,49 ---- modules and converting it into useful formats, such as HTML, XML, and TeX.</P> + <H2>Project Status</H2> + + <P>This project consists of a Python package, “<TT>dps</TT>”. This + contains utility modules and three subpackages, <TT>dps.parsers</TT>, + <TT>dps.formatters</TT>, and <TT>dps.languages</TT>. Each of the subpackages + will contain further modules or packages implementing individual + components.</P> + + <P>Good progress is being made with regards to the parser interface. The <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/dps/statemachine.py?rcontent-type=text/plain" + ><TT>dps.statemachine</TT></A> module is useful for line-based parsing of + input text using regular expressions, and is being used by the <A + HREF="http://structuredtext.sourceforge.net/" >reStructuredText</A> input + parser.</P> + + <P>The <A + HREF="http://prdownloads.sourceforge.net/docstring/dps.0.3.tar.gz" + >latest project release package (dps.0.3.tar.gz)</A> and past project + releases can be downloaded from the <A + HREF="http://sourceforge.net/project/showfiles.php?group_id=26626" >project files + page</A>. <A HREF="http://sourceforge.net/cvs/?group_id=26626">Anonymous CVS + access is available.</A> You can also <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/" + >browse the latest source files (CVS) individually</A>, and read the latest <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/README.txt?rcontent-type=text/plain" + >README.txt</A> and <A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/HISTORY.txt?rcontent-type=text/plain" + >HISTORY.txt</A>.</P> + <H2>Specification</H2> *************** *** 24,77 **** files are included in the <A HREF="http://prdownloads.sourceforge.net/docstring/dps.0.3.tar.gz">latest ! project release package (dps.0.3.tar.gz)</A>, or they can be accessed individually below. Note that some of the individual files below may be newer ! than those included in the latest project release package.</P> <UL> ! <LI><P><A HREF="spec/pep-0256.txt"> PEP 256: Docstring Processing System Framework</A> ! <BR>Date: 2001-07-19. Version: 1.1.1.2. Status: Draft. ! [<A HREF="http://www.python.org/peps/pep-0256.html" >PEP 256 in master repository</A>]<A HREF="#master">*</A> </P></LI> ! <LI><P><A HREF="spec/pep-0257.txt"> PEP 257: Docstring Conventions</A> ! <BR>Date: 2001-07-19. Version: 1.2.1.1. Status: Draft. ! [<A HREF="http://www.python.org/peps/pep-0257.html" >PEP 257 in master repository</A>]<A HREF="#master">*</A> </P></LI> ! <LI><P><A HREF="spec/pep-0258.txt"> PEP 258: DPS Generic Implementation Details</A> ! <BR>Date: 2001-07-19. Version: 1.1.1.3. Status: Draft. ! [<A HREF="http://www.python.org/peps/pep-0258.html" >PEP 258 in master repository</A>]<A HREF="#master">*</A> </P></LI> ! <LI><P><A HREF="spec/gpdi.dtd"> Generic Plaintext Document Interface DTD</A> - <BR>Date: 2001-07-19. Version: 0.2. </P></LI> ! <LI><P><A HREF="spec/ppdi.dtd"> Python Plaintext Document Interface DTD</A> - <BR>Date: 2001-05-29. Version: 0.1. </P></LI> ! <LI><P><A HREF="spec/soextblx.dtd"> OASIS XML Exchange Table Model Declaration Module</A> - <BR>Date: 1999-03-15. </P></LI> ! <LI><P><A HREF="spec/dps.cat"> Python Docstring Processing System Catalog Data</A> - <BR>Date: 2001-05-29. Version: 0.1. </P></LI> ! <LI><P><A HREF="spec/dps-notes.txt"> Notes</A> - <BR>Date: 2001-07-19. Revision: 1.7. </P></LI> --- 53,101 ---- files are included in the <A HREF="http://prdownloads.sourceforge.net/docstring/dps.0.3.tar.gz">latest ! project release package (dps.0.3.tar.gz)</A> (which may not be up to ! date). The up-to-date working documents (from CVS) may be accessed individually below. Note that some of the individual files below may be newer ! than those included in the latest project release package. You can also <A ! HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/spec/" ! >browse the CVS repository</A> directly.</P> <UL> ! <LI><P><A HREF="../dps/spec/pep-0256.txt"> PEP 256: Docstring Processing System Framework</A> ! <BR>[<A HREF="http://www.python.org/peps/pep-0256.html" >PEP 256 in master repository</A>]<A HREF="#master">*</A> </P></LI> ! <LI><P><A HREF="../dps/spec/pep-0257.txt"> PEP 257: Docstring Conventions</A> ! <BR>[<A HREF="http://www.python.org/peps/pep-0257.html" >PEP 257 in master repository</A>]<A HREF="#master">*</A> </P></LI> ! <LI><P><A HREF="../dps/spec/pep-0258.txt"> PEP 258: DPS Generic Implementation Details</A> ! <BR>[<A HREF="http://www.python.org/peps/pep-0258.html" >PEP 258 in master repository</A>]<A HREF="#master">*</A> </P></LI> ! <LI><P><A HREF="../dps/spec/gpdi.dtd"> Generic Plaintext Document Interface DTD</A> </P></LI> ! <LI><P><A HREF="../dps/spec/ppdi.dtd"> Python Plaintext Document Interface DTD</A> </P></LI> ! <LI><P><A HREF="../dps/spec/soextblx.dtd"> OASIS XML Exchange Table Model Declaration Module</A> </P></LI> ! <LI><P><A HREF="../dps/spec/dps.cat"> Python Docstring Processing System Catalog Data</A> </P></LI> ! <LI><P><A HREF="../dps/spec/dps-notes.txt"> Notes</A> </P></LI> *************** *** 82,109 **** <A HREF="http://www.python.org/peps/">master PEP repository</A>.</P> - <H2>Project Status</H2> - - <P>This project consists of a Python package, "<TT>dps</TT>". This contains - utility modules and three subpackages, <TT>dps.parsers</TT>, - <TT>dps.formatters</TT>, and <TT>dps.languages</TT>. Each of the - subpackages will contain further modules or packages implementing - individual components.</P> - - <P>Good progress is being made with regards to the parser interface. The <A - HREF="dps/statemachine.py"><TT>dps.statemachine</TT></A> module is useful for - line-based parsing of input text using regular expressions, and is being used - by the <A HREF="http://structuredtext.sf.net/">reStructuredText</A> input - parser.</P> - - <P>The <A - HREF="http://prdownloads.sourceforge.net/docstring/dps.0.3.tar.gz">latest - project release package (dps.0.3.tar.gz)</A> and past project releases - can be downloaded from the <A - HREF="http://sf.net/project/showfiles.php?group_id=26626">project files - page</A>. You can also <A HREF="http://docstring.sf.net/dps/">browse the - latest source files</A> individually, and read the latest <A - HREF="http://docstring.sf.net/README.txt">README.txt</A> and <A - HREF="http://docstring.sf.net/HISTORY.txt">HISTORY.txt</A>.</P> - <H2>Components</H2> --- 106,109 ---- *************** *** 115,119 **** <LI><P> ! <A HREF="http://structuredtext.sf.net/">reStructuredText</A> input parser </P></LI> --- 115,119 ---- <LI><P> ! <A HREF="http://structuredtext.sourceforge.net/">reStructuredText</A> </P></LI> *************** *** 166,171 **** <UL> ! <LI><P><A HREF="http://sf.net/projects/docstring/">Python Docstring Processing System project page</A></P></LI> <LI><P>Project administrator: --- 166,176 ---- <UL> ! <LI><P>Bug reports, patches, feature requests, mailing lists, news: <A ! HREF="http://sourceforge.net/projects/docstring/" >Python Docstring Processing System project page</A></P></LI> + + <LI><P><A + HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/~checkout~/docstring/dps/" + >Docstring Processing System CVS repository</A></P></LI> <LI><P>Project administrator: |
|
From: David G. <go...@us...> - 2001-08-04 15:07:28
|
Update of /cvsroot/docstring/web
In directory usw-pr-cvs1:/tmp/cvs-serv12200/web
Modified Files:
templater.py
Log Message:
x-platform fixes
Index: templater.py
===================================================================
RCS file: /cvsroot/docstring/web/templater.py,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** templater.py 2001/07/22 22:42:42 1.1
--- templater.py 2001/08/04 15:07:26 1.2
***************
*** 35,39 ****
def scanfile(path, file):
##print >>sys.stderr, 'path=%s, file=%s' % (path, file)
! inputlines = string2lines(open(os.path.join(path, file)).read())
sm = StateMachine([ScanState], initialstate='ScanState')
results = sm.run(inputlines)
--- 35,40 ----
def scanfile(path, file):
##print >>sys.stderr, 'path=%s, file=%s' % (path, file)
! filename = os.path.normpath(os.path.join(path, file))
! inputlines = string2lines(open(filename).read())
sm = StateMachine([ScanState], initialstate='ScanState')
results = sm.run(inputlines)
***************
*** 85,89 ****
def main(template, path, files):
! templatelines = open(template).readlines()
output = templater(templatelines, path, files)
outputname = template[:template.rfind('.')]
--- 86,92 ----
def main(template, path, files):
! templatetext = open(template).read()
! templatetext = templatetext.replace("\r\n", "\n").replace("\r", "\n")
! templatelines = templatetext.splitlines(1)
output = templater(templatelines, path, files)
outputname = template[:template.rfind('.')]
|
