You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Xiangrui Meng (JIRA)" <ji...@apache.org> on 2014/12/18 02:32:18 UTC
[jira] [Updated] (SPARK-4822) Use sphinx tags for Python doc
annotations
[ https://issues.apache.org/jira/browse/SPARK-4822?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Xiangrui Meng updated SPARK-4822:
---------------------------------
Assignee: Kai Sasaki
> Use sphinx tags for Python doc annotations
> ------------------------------------------
>
> Key: SPARK-4822
> URL: https://issues.apache.org/jira/browse/SPARK-4822
> Project: Spark
> Issue Type: Documentation
> Components: Documentation, PySpark
> Affects Versions: 1.2.0
> Reporter: Joseph K. Bradley
> Assignee: Kai Sasaki
> Priority: Minor
> Fix For: 1.3.0
>
>
> Currently, pyspark documentation uses the same annotations as in Scala:
> {code}
> :: Experimental ::
> {code}
> It should use Sphinx annotations:
> {code}
> .. note:: Experimental
> {code}
> The latter method creates a box. The former method must either be on the same line as the rest of the doc text, or it generates compilation warnings.
> Proposal: Change all annotations in Python docs to use "note"
--
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