Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-4822

Use sphinx tags for Python doc annotations

    XMLWordPrintableJSON

Details

    • Documentation
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 1.2.0
    • 1.3.0
    • Documentation, PySpark
    • None

    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"

      Attachments

        Activity

          People

            lewuathe Kai
            josephkb Joseph K. Bradley
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: