[jira] [Commented] (ARIA-257) Docstrings standard

["Ran Ziv (JIRA)" <ji...@apache.org>]

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

Ran Ziv commented on ARIA-257:
------------------------------

After a discussion on the mailing list it's been decided to use the {{reST}} standard (over Google's or NumPy's)

Can view an example [here|http://blog.dolphm.com/pep257-good-python-docstrings-by-example/]

More information [here|http://www.sphinx-doc.org/en/1.4.8/rest.html]

Quickref [here|http://docutils.sourceforge.net/docs/user/rst/quickref.html]

{{Sphinx}} will be the tool used with these.


> Docstrings standard
> -------------------
>
>                 Key: ARIA-257
>                 URL: https://issues.apache.org/jira/browse/ARIA-257
>             Project: AriaTosca
>          Issue Type: Task
>            Reporter: Ran Ziv
>            Priority: Minor
>             Fix For: 0.1.0
>
>
> Decide on a documentation string standard to be used throughout ARIA's code



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)