Sorry Christina, I didn't enter my comment in a Markdown-friendly way.  I
meant for the comments to follow this wiki page:
https://edx-wiki.atlassian.net/wiki/display/ENG/Python+Guidelines

For example:

    """
    When the class is instantiated, it will be available as an instance
attribute of the same
    name, by proxying through to `self._model_data` on the containing
object.

    Parameters:

    `help`: documentation of field class, suitable....

    """

--Ned.


On Mon, Apr 29, 2013 at 4:46 PM, Christina Roberts <notifications@github.com
> wrote:

> In xblock/core.py:
>
> > @@ -61,15 +61,27 @@ class ModelType(object):
> >
> >      When the class is instantiated, it will be available as an instance attribute of the same
> >      name, by proxying through to self._model_data on the containing object.
> > +
> > +    Parameters:
> > +      help - documentation of field class, suitable for presenting in a GUI (defaults to None)
>
> I didn't see anyplace in XBlock where the docstring included a list of
> parameters. I'd like it to be consistent as well, but I wasn't sure what
> pattern to follow.
>
> I will change the hypens to colons.
>
> —
> Reply to this email directly or view it on GitHub<https://github.com/edx/XBlock/pull/14/files#r4007352>
> .
>