On Tue, Mar 23, 2010 at 8:16 PM, Armstrong, Richard J. <rarms...@water.ca.gov> wrote: > Hello, > > > > I have a simple question. I have created a module call Newmark.py and it > runs fine, however, I want to add some documentation so that when I type in > the console help(Newmark) it will give a description of the module. Any > ideas? >
Simply add a docstring to the top of your module, below the shebang line but above the imports (At least that's where I always put it), just like you would add documentation to functions and classes. Here's the PEP describing docstring conventions: http://www.python.org/dev/peps/pep-0257/ Hugo _______________________________________________ Tutor maillist - Tutor@python.org To unsubscribe or change subscription options: http://mail.python.org/mailman/listinfo/tutor
