docstrings

Laura Creighton lac at cd.chalmers.se
Thu May 31 13:26:42 EDT 2001


oops I am an idiot. I don't want to _use_ docstrings, I want to'
write even more excellent ones that I do now following whatever
conventions there are.  As far as I know we INVENTED the things,
on Genesis an LPMUD (they predate java at any rate who got from
us).  Actually, 2 people in this company invented them with one
more guy who isn't part of this company (alas).  I was on the
other side, actively opposing their adoption.  I was wrong.  So
2 people in this company have already made their significant
contribution to the betterment of humanity.  And I nearly became
unknown public enemy number one.

Pythons implementation of docstrings is way cooler than ours is
as well.  

Our existing docstrings, written exaclty the way we have been
coding together every day of our lives for the last decade 
do not work here.  But that is because in the crash course of
learn python in a month or 6, none of us had read about docstrings
until I did the day before yesterday.  Ooops.  We have followed our
usual tradition of having 3 times the amount of documentation as
the code, so we have 10s of thousands of lines of docuemntation,
and it all doesn't work.

But it is to a fixed pattern.  So if I know what patterns I want,
I can write a python script to convert them in a flash.

Laura






More information about the Python-list mailing list