[SPARK-4822] Use sphinx tags for Python doc annotations

• Type: Documentation
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.2.0
• Fix Version/s: 1.3.0
• Component/s: Documentation, PySpark
• Target Version/s: 1.3.0
• Assignee: Kai
• Reporter: Joseph K. Bradley
• Created: 10/Dec/14 23:21
• Updated: 18/Dec/14 01:31
• Resolved: 18/Dec/14 01:31

Description

Currently, pyspark documentation uses the same annotations as in Scala:

:: Experimental ::

It should use Sphinx annotations:

.. note:: Experimental

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"

Issue Links

• links to: [Github] Pull Request #3685 (Lewuathe)