[Python-bugs-list] [Bug #115308] codecs base classes need documentation

[noreply@sourceforge.net]

Bug #115308, was updated on 2000-Sep-25 12:00
Here is a current snapshot of the bug.

Project: Python
Category: Documentation
Status: Closed
Resolution: Fixed
Bug Group: None
Priority: 5
Summary: codecs base classes need documentation

Details: The documentation for the codecs module includes a note that base classes need to be implemented; this needs to happen for the 2.0 final release.

There should be some note at the top of the section about what the module is for -- Unicode is not mentioned, but that's the primary (expected) use.  Let's say something about that, and perhaps give examples at the end (especially for handling encoded files).

For the open() function, the docs refer to a "buffering" parameter, and say that it matches the meaning of the the same thing for the open() built-in.  It should be called "bufsize" to match the built-in documentation.

Follow-Ups:

Date: 2000-Sep-25 14:03
By: lemburg

Comment:
I'll try to write something up, but can't promise anything this
week. I that's a problem, you'll have to assign the bug
to someone else.

Note that the codecs.py module has extensive doc-string
documentation which can be used as basis.

-------------------------------------------------------

Date: 2000-Oct-07 02:01
By: lemburg

Comment:
I'll try to get around and put something together next week.

When is the 2.0 docs deadline, BTW ?

-------------------------------------------------------

Date: 2000-Oct-12 13:53
By: fdrake

Comment:
Closed using content based on patch #101877, checked in as Doc/lib/libcodecs.tex revision 1.4.
-------------------------------------------------------

For detailed info, follow this link:
http://sourceforge.net/bugs/?func=detailbug&bug_id=115308&group_id=5470