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

Use sphinx tags for Python doc annotations

Rank to TopRank to BottomAttach filesAttach ScreenshotBulk Copy AttachmentsBulk Move AttachmentsVotersWatch issueWatchersCreate sub-taskConvert to sub-taskLinkCloneLabelsUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    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
          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

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

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment