Re: [Docutils-develop] docutils api docs

[David G. <go...@us...>]

> David Goodger wrote:
>> I recently moved the bibliographic fields that were in all the
>> module docstrings into simple comments.  This gets rid of ":Author:
>> David Goodger :Contact: goodger@users." from the API docs of almost
>> EVERY SINGLE MODULE ENTRY!

Tony J Ibbs (Tibs) wrote:
> I'd wondered why you'd done that - it seems like docstring-relevant
> stuff to me. Is it just embarassment over having your name everywhere? I
> mean, if you wrote it...

It wasn't in anticipation of Richard producing API docs -- those were an
unexpected surprise.  It was in anticipation of eventually producing API
docs; it seemed overly verbose to include that info in every module's
docstring.  The epydoc API docs merely confirmed what I had suspected.  I
began moving them in modules I was editing for some other reason, and then
one day I did a mass edit, made easy thanks to Emacs' directory-edit-mode
and query-replace tools.

Yes, I wrote much of the code, but a comment is good enough.  The developer
looking for API clues doesn't need to see my name front & center.

-- 
David Goodger  <go...@us...>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
    (includes reStructuredText: http://docutils.sf.net/rst.html)
  - The Go Tools Project: http://gotools.sourceforge.net/