Style guide and docstring conventions for Ganga source code

The docstring should follow the pydoc convention: the first non-blank line is a short description. It should be followed by a blank line. And then comes the long description. For example:

 class SomeGPIClass:
   """
    short description (just one line). this may be a single line in the docstring.

    long1.
    long2.
    long3....
   """

The following PEPs outline the recommended style guide and docstring conventions for Ganga source code:

PEP 8 -- Style Guide for Python Code: http://www.python.org/dev/peps/pep-0008/

PEP 257 -- Docstring Conventions: http://www.python.org/dev/peps/pep-0257/

-- Main.dtuckett - 27 Jun 2007

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r2 - 2007-07-10 - JakubMoscicki
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    ArdaGrid All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback