On Wed, Mar 4, 2009 at 3:06 AM, Alan Gauld wrote:
>
> "Carlos Daniel Ruvalcaba Valenzuela" wrote
>
>> which approach should I take on documentation (API docs) for a python
>> library I have been working on, there is currently code docstrings,
>
> docstrings are the minimum since they show up on h
Alan Gauld wrote:
In your experience which way is the best or what
advantages/disadvantages do you see (experienced) with each approach
that you are familiar.
Fancy markup is a wasted luxury so far as I am concerned.
Not to mention that using non-docstring documentation breaks help(), and
us
"Carlos Daniel Ruvalcaba Valenzuela" wrote
which approach should I take on documentation (API docs) for a
python
library I have been working on, there is currently code docstrings,
docstrings are the minimum since they show up on help()
docstrings with some markup (epydoc, etc), or extern
Hello list,
I have been coding in python a short while and I have been wondering
which approach should I take on documentation (API docs) for a python
library I have been working on, there is currently code docstrings,
docstrings with some markup (epydoc, etc), or external programs such
as Sphinx
