discuss: LDP Style Guide
Subject:
Re: LDP Style Guide
From:
Charles Curley ####@####.####
Date:
19 Mar 2002 20:42:40 -0000
Message-Id: <20020319134124.M6400@trib.com>
On Tue, Mar 19, 2002 at 12:29:04PM -0600, Joy Y Goodreau muttered:
> I am interested in putting together a style guide for the LDP to
> guide reviewers and authors in publishing and maintaining high
> quality documentation. Unlike other Style Guide projects in
> existence, this would be tailored towards developers, not toward
> individuals who already know what "gerund phrases" and "dangling
> participles" are. In fact, this Guide will try a new approach to
> style by providing an easy-to-use reference for style that includes,
> instead of excluding, would be writers.
There are two good style guides of the traditional type (i.e. what you
don't want here :-).
One is "Microsoft® Manual of Style for Technical Publications", Second
Edition, http://www.microsoft.com/MSPress/books/1780.asp. I used an
earlier version of this and found it useful. That version was heavily
geared to Microsoft specific terminology, though.
The other is "Read Me First! A Style Guide for the Computer Industry",
http://www.sun.com/books/catalog/EdStyle/index.html. I have not used
it. According to the blurb on the web page, it also covers documenting
GUI programs and documentation management, which regular style guides
do not cover.
Joy, you might think about these two for the bibliography of your
style guide. Meanwhile, other folks may find them useful.
--
Charles Curley /"\ ASCII Ribbon Campaign
Looking for fine software \ / Respect for open standards
and/or web pages? X No HTML/RTF in email
http://w3.trib.com/~ccurley / \ No M$ Word docs in email
--> -->
<type 'exceptions.IOError'> | Python 2.5.2: /usr/bin/python
Mon Jul 1 15:21:37 2024 |
A problem occurred in a Python script. Here is the sequence of
function calls leading up to the error, in the order they occurred.
| /opt/ezmlm-browse-0.20/main.py in main() |
424
|
425 if path is not None:
|
426 main_path(path)
|
427 else:
|
428 main_form()
|
| global main_form = <function main_form at 0x9b1bc6c> |
| /opt/ezmlm-browse-0.20/main.py in main_form() |
378 except ImportError:
|
379 die(ctxt, "Invalid command")
|
380 module.do(ctxt)
|
381
|
382 def main():
|
| module = <module 'commands.showmsg' from '/opt/ezmlm-browse-0.20/commands/showmsg.pyc'>, module.do = <function do at 0x9b306bc>, global ctxt = {'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'} |
| /opt/ezmlm-browse-0.20/commands/showmsg.py in do(ctxt={'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}) |
18 write(html('msg-pager') % ctxt)
|
19 write('<hr>')
|
20 sub_showmsg(ctxt, ctxt[MSGNUM])
|
21 write('<hr>')
|
22 write(html('msg-pager') % ctxt)
|
| global sub_showmsg = <function sub_showmsg at 0x9b1b1ec>, ctxt = {'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, global MSGNUM = 'msgnum' |
| /opt/ezmlm-browse-0.20/globalfns.py in sub_showmsg(ctxt={'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, msgnum=2600) |
229 format_timestamp(ctxt, ctxt)
|
230 write(html('msg-header') % ctxt)
|
231 rec_showpart(ctxt, msg, 0)
|
232 write(html('msg-footer') % ctxt)
|
233 ctxt.pop()
|
| global rec_showpart = <function rec_showpart at 0x9b1b1b4>, ctxt = {'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, msg = <email.message.Message instance at 0x9b8ddcc> |
| /opt/ezmlm-browse-0.20/globalfns.py in rec_showpart(ctxt={'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, part=<email.message.Message instance at 0x9b8ddcc>, partnum=1) |
205 else:
|
206 for p in part.get_payload():
|
207 partnum = rec_showpart(ctxt, p, partnum+1)
|
208 else:
|
209 write(html('msg-sep') % ctxt)
|
| partnum = 1, global rec_showpart = <function rec_showpart at 0x9b1b1b4>, ctxt = {'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, p = <email.message.Message instance at 0x9b950ac> |
| /opt/ezmlm-browse-0.20/globalfns.py in rec_showpart(ctxt={'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, part=<email.message.Message instance at 0x9b950ac>, partnum=2) |
208 else:
|
209 write(html('msg-sep') % ctxt)
|
210 sub_showpart(ctxt, part)
|
211 return partnum
|
212
|
| global sub_showpart = <function sub_showpart at 0x9b1b144>, ctxt = {'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, part = <email.message.Message instance at 0x9b950ac> |
| /opt/ezmlm-browse-0.20/globalfns.py in sub_showpart(ctxt={'cmd': 'showmsg', 'threadidx': 2, 'HTTP_X_FORWA...HTTP_ACCEPT_ENCODING': 'gzip, br, zstd, deflate'}, part=<email.message.Message instance at 0x9b950ac>) |
164 type = ctxt[TYPE] = part.get_content_type()
|
165 ctxt[FILENAME] = part.get_filename()
|
166 template = html('msg-' + type.replace('/', '-'))
|
167 if not template:
|
168 template = html('msg-' + type[:type.find('/')])
|
| global template = <function template at 0x9b13e9c>, global html = <function html at 0x9b13ed4>, type = 'application/pgp-signature', type.replace = <built-in method replace of str object at 0x9b90c28> |
| /opt/ezmlm-browse-0.20/globalfns.py in html(name='msg-application-pgp-signature') |
40
|
41 def html(name):
|
42 return template(name + '.html')
|
43
|
44 def xml(name):
|
| global template = <function template at 0x9b13e9c>, name = 'msg-application-pgp-signature' |
| /opt/ezmlm-browse-0.20/globalfns.py in template(filename='msg-application-pgp-signature.html') |
31 except IOError:
|
32 if not _template_zipfile:
|
33 _template_zipfile = zipfile.ZipFile(sys.argv[0])
|
34 try:
|
35 f = _template_zipfile.open(n).read()
|
| global _template_zipfile = None, global zipfile = <module 'zipfile' from '/usr/lib/python2.5/zipfile.pyc'>, zipfile.ZipFile = <class zipfile.ZipFile at 0x9aaca7c>, global sys = <module 'sys' (built-in)>, sys.argv = ['-c', '/opt/ezmlm-browse-0.20'] |
| /usr/lib/python2.5/zipfile.py in __init__(self=<zipfile.ZipFile instance at 0x9b2cb0c>, file='-c', mode='r', compression=0, allowZip64=False) |
337 self.filename = file
|
338 modeDict = {'r' : 'rb', 'w': 'wb', 'a' : 'r+b'}
|
339 self.fp = open(file, modeDict[mode])
|
340 else:
|
341 self._filePassed = 1
|
| self = <zipfile.ZipFile instance at 0x9b2cb0c>, self.fp = None, builtin open = <built-in function open>, file = '-c', modeDict = {'a': 'r+b', 'r': 'rb', 'w': 'wb'}, mode = 'r' |
<type 'exceptions.IOError'>: [Errno 2] No such file or directory: '-c'
args =
(2, 'No such file or directory')
errno =
2
filename =
'-c'
message =
''
strerror =
'No such file or directory'
