You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Nicholas Chammas (JIRA)" <ji...@apache.org> on 2015/05/13 22:57:59 UTC

[jira] [Comment Edited] (SPARK-7606) Document all PySpark SQL/DataFrame public methods with @since tag

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

Nicholas Chammas edited comment on SPARK-7606 at 5/13/15 8:57 PM:
------------------------------------------------------------------

Just looked into this. If we are using Sphinx for the docs, which I believe we are, then there are the {{.. versionadded::}} and {{.. versionchanged::}} tags.

http://sphinx-doc.org/markup/para.html#directive-versionadded

This is what the Python standard library uses. For example:

https://docs.python.org/3.5/library/subprocess.html#subprocess.run
https://github.com/python/cpython/commit/9ed5f6e6e7ec5afefdb17bab6106881d8fddba68#diff-7843f151fe534572c98062d58b998ba8R120

{quote}
New in version 3.5.
{quote}

What's the relevance of dynamic typing here?


was (Author: nchammas):
Just looked into this. If we are using Sphinx for the docs, which I believe we are, then there are the {{::versionadded}} and {{::versionchanged}} tags.

http://sphinx-doc.org/markup/para.html#directive-versionadded

This is what the Python standard library uses. For example:

https://docs.python.org/3.5/library/subprocess.html#subprocess.run
https://github.com/python/cpython/commit/9ed5f6e6e7ec5afefdb17bab6106881d8fddba68#diff-7843f151fe534572c98062d58b998ba8R120

{quote}
New in version 3.5.
{quote}

What's the relevance of dynamic typing here?

> Document all PySpark SQL/DataFrame public methods with @since tag
> -----------------------------------------------------------------
>
>                 Key: SPARK-7606
>                 URL: https://issues.apache.org/jira/browse/SPARK-7606
>             Project: Spark
>          Issue Type: Sub-task
>          Components: SQL
>            Reporter: Nicholas Chammas
>            Priority: Blocker
>             Fix For: 1.4.0
>
>




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

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org