[jira] [Commented] (CLIMATE-465) Add class level documentation to all OCW python examples

["Michael Anderson (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CLIMATE-465?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15175429#comment-15175429 ] 

Michael Anderson commented on CLIMATE-465:
------------------------------------------

1.  Added ASF headers.
2.  Added summary docstring at top of file.
3.  Pylint:  Converted tab to spaces.
4.  Pylint:  Removed unused imports.
5.  Pylint:  Short lines exceeding length limit where it made sense.
6.  Minor refactoring to provide consistency across examples.

> Add class level documentation to all OCW python examples
> --------------------------------------------------------
>
>                 Key: CLIMATE-465
>                 URL: https://issues.apache.org/jira/browse/CLIMATE-465
>             Project: Apache Open Climate Workbench
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 0.3-incubating
>            Reporter: Lewis John McGibbney
>             Fix For: 1.2
>
>
> Currently documentation is absent from the four examples we maintain within /examples. 
> This is bad and it takes time to understand what the example should actually do.
> Additionally, only one of the examples files actually carries an ASLv2.0 license header. We should also fix that within this issue.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)