Sure. Thanks.


On Thu, Mar 20, 2014 at 10:21 AM, David Baumgold
<notifications@github.com>wrote:

> In common/lib/xmodule/xmodule/tabs.py:
>
> > +    # Class property that specifies the type of the tab.  It is generally a constant value for a
> > +    # subclass, shared by all instances of the subclass.
> > +    type = ''
> > +
> > +    def __init__(self, name, tab_id, link_func):
> > +        """
> > +        Initializes class members with values passed in by subclasses.
> > +
> > +        'name' is the name of the tab
> > +
> > +        'tab_id' is intended to be a unique id for this tab, although it is currently not enforced
> > +        within this module.  It is used by the UI to determine which page is active.
> > +
> > +        'link_func' is a function that computes the link for the tab,
> > +        given the course and a reverse-url function as input parameters
> > +        """
>
> We're using Sphinx <http://sphinx-doc.org/> and sphinxcontrib-napoleon<https://pypi.python.org/pypi/sphinxcontrib-napoleon>to build documentation for parts of our project -- even though I don't
> think we're building docs for these files right now, it would still be good
> to get in the habit of having a consistent, parsable style for documenting
> things like function arguments. Can you document these arguments in one of
> the ways that these tools support? I'd be happy to help you out with that,
> if you'd like.
>
> --
> Reply to this email directly or view it on GitHub<https://github.com/edx/edx-platform/pull/2910/files#r10796437>
> .
>



-- 

edX | nasthagiri@edx.org <andya@edx.org>

141 Portland Street, 9th floor

Cambridge, MA 02139
http://www.edx.org <http://www.edxonline.org/>

[image:
http://www.e-learn.nl/media/blogs/e-learn/edX_Logo_Col_RGB_FINAL.jpg?mtime=1336074566]