selphi...@gmail.com writes:
> I am trying to understand how to write good API documentation. I have read
> “7. Documenting Python” in the python developers guide [1] and skimmed the
> Doc-SIG email archives, but I still have some questions and I would
> appreciate your help. (Whenever I refer to
On Tue, 07 Mar 2017 17:06:03 -0800, selphiron wrote:
> Hello,
>
> I am trying to understand how to write good API documentation.
Nice questions!
> 1) How much should I (or a documentation author in general) go into
> detail? I don’t want to bore experienced users, but I don’t want to
> scare b
Hello,
I am trying to understand how to write good API documentation. I have read “7.
Documenting Python” in the python developers guide [1] and skimmed the Doc-SIG
email archives, but I still have some questions and I would appreciate your
help. (Whenever I refer to me in the following questio
