[Python-Dev] Re: undocumented api functions

Terry Reedy tjreedy at udel.edu
Wed Jun 9 17:58:07 EDT 2004


"Thomas Heller" <theller at python.net> wrote in message
news:y8mwtu2r.fsf at python.net...
> Every so often, when writing C extensions, or embedding Python, I
> encounter api functions which seem to be useful, but they are
> undocumented.  I brought the Doc/tools/undoc_symbols.py script up to
> date - this uses ctags to find function declarations, macro definitions
> and typedefs, then looks through the .tex files whether they are
> mentioned or not.
>
> Currently, for CVS head, it finds 239 undocumented function prototypes.
> Probably most of them should better stay undocumented and unused by
> extension writers,

Perhaps these could be tagged, if they are not now, in a way, such as /*
NOT API */, that both readers and your script could recognize.

TJR






More information about the Python-Dev mailing list