On Thu, Mar 15, 2012 at 6:27 AM, Michael Foord <[email protected]> wrote: > On the topic of docs.... mock documentation is about eight pages long. My > intention was to strip this down to just the api documentation, along with a > link to the docs on my site for further examples and so on. I was encouraged > here at the sprints to include the full documentation instead (minus the mock > library comparison page and the front page can be cut down). So this is what > I am now intending to include. It does mean the mock documentation will be > "extensive".
Don't forgot you also have the option of splitting out a separate HOWTO tutorial section, leaving the main docs as a pure API reference. (I personally find that style easier to use than the ones which try to address both needs in the main module docs). Cheers, Nick. -- Nick Coghlan | [email protected] | Brisbane, Australia _______________________________________________ Python-Dev mailing list [email protected] http://mail.python.org/mailman/listinfo/python-dev Unsubscribe: http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
