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

Improve examples and scenarios in docstrings

Log workAgile BoardRank to TopRank to BottomAttach filesAttach ScreenshotAdd voteVotersWatch issueWatchersCreate sub-taskConvert to sub-taskLinkCloneLabelsUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 3.1.0
    • Fix Version/s: None
    • Component/s: Documentation, PySpark
    • Labels:
      None

      Description

      Currently, PySpark documentation does not have a lot of examples and scenarios. See also https://github.com/apache/spark/pull/30149#issuecomment-716490037.

      We should add/improve examples especially in the commonly used APIs. For example, Column, DataFrame. RDD, SparkContext, etc.

      This umbrella JIRA targets to improve them in commonly used APIs.

      NOTE that we'll have to convert the docstrings into numpydoc style first in a separate PR (at SPARK-32085), and then add examples. In this way, we can manage migration to numpydoc and example improvement here separately (e.g., reverting numpydoc migration only).

        Attachments

        Issue Links

          Activity

          $i18n.getText('security.level.explanation', $currentSelection) Viewable by All Users
          Cancel

            People

              Dates

              • Created:
                Updated:

                Issue deployment