Joseph K. Bradley created SPARK-4822:
----------------------------------------
Summary: 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
Priority: Minor
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: [email protected]
For additional commands, e-mail: [email protected]