classification
Title: Bdb documentation
Type: Stage:
Components: Documentation Versions: Python 3.0, Python 2.6
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: arklad, georg.brandl, tim.golden
Priority: normal Keywords: patch

Created on 2007-09-09 15:09 by arklad, last changed 2007-09-12 18:05 by georg.brandl. This issue is now closed.

Files
File name Uploaded Description Edit
bdb.rst arklad, 2007-09-09 15:09
bdb.rst tim.golden, 2007-09-12 13:19
Messages (5)
msg55766 - (view) Author: Cristina Yenyxe González García (arklad) Date: 2007-09-09 15:09
Hello,

I thought it could be interesting to write some documentation for the
bdb module, since it keeps undocumented on Python 2.6 and 3.0. The
document I attach is written in reStructuredText, and for using it with
2.5 it only needs to change the header for the 'Bdb.user_exception'
method (and convert to LaTeX format, of course).

It will thank a revision because there can be some grammatical errors
(I'm from Spain). Anyway, I hope it helps, and any comment will be
welcomed :D
msg55840 - (view) Author: Tim Golden (tim.golden) (Python committer) Date: 2007-09-12 13:19
I've reviewed the docs for English and general readability. As
mentioned, I've no idea of the tech involved. I did look through the
bdb.py source and the existing docs for pdb to get some idea of the
terminology used. Ultimately I've changed very little; in a couple of
places the English was just wrong and in a couple of others I felt a
small change improved things.

One thing I couldn't work out is that arklad, the author, used "canonic"
throughout which I've never seen used. I would simply have changed it to
"canonical" except that the code itself uses "canonic" as a function
name! In addition, there's no explanation of what canonic(al) means in
the context. I've left ?TJG? marks around all the instances.
msg55842 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2007-09-12 15:39
Thanks for reviewing, I'll finish and commit that one shortly.
msg55844 - (view) Author: Cristina Yenyxe González García (arklad) Date: 2007-09-12 16:35
Oops, of course a filename should be in canonical form (an absolute name
which does not contain repeated path separators or symbolic links)!
msg55848 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2007-09-12 18:05
Okay, committed as rev. 58112, 58113. Thank you!
History
Date User Action Args
2007-09-12 18:05:02georg.brandlsetstatus: open -> closed
resolution: accepted
messages: + msg55848
2007-09-12 16:35:21arkladsetmessages: + msg55844
2007-09-12 15:39:13georg.brandlsetassignee: georg.brandl
messages: + msg55842
nosy: + georg.brandl
2007-09-12 13:19:14tim.goldensetfiles: + bdb.rst
nosy: + tim.golden
messages: + msg55840
2007-09-09 16:49:40loewissetkeywords: + patch
2007-09-09 15:09:58arkladcreate