add pydoc (or similar) style comments to advent.py

gever / bwx-adventure

A simple module for writing text adventure games in python.

MIT License

70 stars 30 forks source link

add pydoc (or similar) style comments to advent.py #19

Open walnerz opened 9 years ago

walnerz commented 9 years ago

We should leverage a doc generation tool like pydoc to create documentation for game developers

gever commented 9 years ago

agreed!

On Wed, Dec 31, 2014 at 10:01 AM, Andrew Lambeth notifications@github.com wrote:

We should leverage a doc generation tool like pydoc to create documentation for game developers

— Reply to this email directly or view it on GitHub https://github.com/gever/bwx-adventure/issues/19.

Gever Tulley, Founder, Education Architect Brightworks: An Extraordinary School Tinkering School: Think, Make, Tinker (415) 701-8700 | sfbrightworks.org | cell: (415) 218-0812

royseto commented 9 years ago

Maybe we can use this to generate API doc for the major classes on GitHub Pages using an approach like this: http://obriencj.preoccupied.net/blog/2014/02/09/python/.