Any documentation work always makes me happy :-) I don't completely
understand your proposal however - would the script generate a page
like  for wikipedia.py?
I have suffered for a long time because I have quite a lot of fixes and I
can hardly find my way in this jungle and keep a logical order and find old
So I decided to write a script that creates a table of contents int
Then I thought it should also list main-level variables and functions
(Python is very good at dissolving main-level things from others :-)). As I
already wrote earlier, I use several own functions for my fixes (). And
also header lines of some predefined format. All this script needs a place
to insert the TOC which should be a predefined constant line, e.g.
# *** CONTENTS *** #
(If the script finds the corresponding END CONTENTS line, it clears the
previous TOC from between these two.)
But then I realized that enhanced with classes this would be useful for any
kind of scripts without extra work. For example in wikipedia.py which is now
long, long, and hard to overview.
Of course, there would be a possibility to leave some kind of data (e.g. "no
variables please, only functiions and classes"), and two approaches for
ordering (everything in original order, or fisrt the variables, then
functions, then fixes...).
Unfortunately, in some rare cases the length of a line may excced the 80
characters, which may cause PEP8 and/or Xqt beiing sad. :-)
How does this concept sound?
I will anyhow write it for my own purposes. It is just about community use
for complicated scripts such as fixes.py or wikipedia.py.
Pywikipedia-l mailing list