Differences between revisions 12 and 17 (spanning 5 versions)
Revision 12 as of 2006-03-31 14:49:12
Size: 1221
Editor: BSN-77-113-216
Comment:
Revision 17 as of 2025-02-16 06:02:50
Size: 67
Editor: AdamTurner
Comment: Redirect readers to the devguide
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
This page lists various things that aren't documented in the main Python docs,
but should be. We should try to fix these before 2.5final.

= Features =

The reference manual doesn't mention new-style classes at all. (I can't see that it really specifies the semantics of old-style classes, either.) I'm not sure the information is even collected anywhere. A start is now at NewClassVsClassicClass

Iterator protocol not described on its own (mentioned in passing in ref's discussion of generators)

Are nested scopes explained in the ref?

PEPS that aren't covered: new-style classes.

= Other tasks =

Also see ModulesThatNeedDocs.

Add example code to various modules.


= Relevant SF bugs =

SF:984952 PEP 307 not documented (mostly done -- needs a pickle expert to decide if anything else in PEP 307 is worth including).

SF:970783 PyObject_GenericGetAttr is undocumented

SF:966625 descriptors not documented

SF:960340 new-style classes (some documentation was already added to [http://docs.python.org/dev/ref/node33.html Python Reference Manual])

SF:914375 modulefinder

SF:813198 Migrate PEP material to docs

SF:779976 trace undocumented

SF:515751 imputil undocumented
See https://devguide.python.org/documentation/start-documenting/.

MissingFromDocumentation (last edited 2025-02-16 06:02:50 by AdamTurner)

Unable to edit the page? See the FrontPage for instructions.