This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Python bsddb docs need update
Type: Stage:
Components: Documentation Versions: Python 2.3
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: jcea Nosy List: barry, gregory.p.smith, jcea
Priority: low Keywords:

Created on 2003-05-01 18:42 by barry, last changed 2022-04-10 16:08 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
bsddb-doc-small-update.patch gregory.p.smith, 2003-05-01 19:14
Messages (7)
msg15805 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2003-05-01 18:42
We need to do /something/ about the bsddb module
documentation in Python 2.3.  The current docs are for
the old bsddb module and they're worse than out-of-date.  

Ideally, we'd import pybsddb's documentation in Python
latex format, and add docs for all the auxiliary
modules that come in the bsddb package.

If we don't have time for that, we should at least
update the docs to point to the pybsddb site and
document the list of additional modules.
msg15806 - (view) Author: Gregory P. Smith (gregory.p.smith) * (Python committer) Date: 2003-05-01 19:12
Logged In: YES 
user_id=413

Yes, this is important.  I've attached a patch against the
current python documentation that points to pybsddb.  I've
never edited the python latex docs before and am not
currently setup for compiling/viewing the updates or
verifying that i used the correct syntax.

can you review it and check it in if it makes sense?

unfortunately even the pybsddb project's documentation is a
bit dated (mostly in that several new features/functions
have been exposed since it was written) but it is a *much*
better starting point.
msg15807 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2003-05-01 19:15
Logged In: YES 
user_id=12800

Taking ownership to review
msg15808 - (view) Author: Gregory P. Smith (gregory.p.smith) * (Python committer) Date: 2003-05-28 08:05
Logged In: YES 
user_id=413

I cleaned up my patch and committed the update to the
documentation that mentions the modern Db and DbEnv
interface with a URL to the pybsddb documentation.  That
should suffice for now until proper pybsddb documentation
can be cleaned up, updated and put in as a TeX of its own.

I'm leaving this bug open in the Later state with a low
priority to track the inclusion of native Db, DbEnv object
documentation.
msg61566 - (view) Author: Gregory P. Smith (gregory.p.smith) * (Python committer) Date: 2008-01-23 08:22
ReST format docs that cover what is actually implemented and wrapped in
python would be good.  We need a volunteer willing to go through and do it.
msg64445 - (view) Author: Jesús Cea Avión (jcea) * (Python committer) Date: 2008-03-24 22:21
Done in the pybssdb module (the external one, not the included in python
distribution). Online docs available at
http://www.argo.es/~jcea/programacion/pybsddb_doc/

The source "rst" files should be directly usable in the stock 2.6
documentation.
msg101106 - (view) Author: Jesús Cea Avión (jcea) * (Python committer) Date: 2010-03-15 13:40
http://www.jcea.es/programacion/pybsddb_doc/
History
Date User Action Args
2022-04-10 16:08:30adminsetgithub: 38417
2010-03-15 13:40:29jceasetstatus: open -> closed
assignee: jcea
resolution: later -> accepted
messages: + msg101106
2008-03-24 22:21:05jceasetmessages: + msg64445
2008-01-23 08:22:58gregory.p.smithsetassignee: gregory.p.smith -> (no value)
title: Python 2.3 bsddb docs need update -> Python bsddb docs need update
messages: + msg61566
nosy: + jcea
2003-05-01 18:42:18barrycreate