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

Migrate to NumPy documentation style

    XMLWordPrintableJSON

Details

    • Umbrella
    • Status: Resolved
    • Major
    • Resolution: Done
    • 3.1.0
    • 3.1.0
    • PySpark
    • None

    Description

      https://github.com/numpy/numpydoc

      For example,

      Before: https://github.com/apache/spark/blob/f0e6d0ec13d9cdadf341d1b976623345bcdb1028/python/pyspark/sql/dataframe.py#L276-L318
      After: https://github.com/databricks/koalas/blob/6711e9c0f50c79dd57eeedb530da6c4ea3298de2/databricks/koalas/frame.py#L1122-L1176

      We can incrementally start to switch.

      NOTE that this JIRA targets only to switch the style. It does not target to add additional information or fixes together.

      Attachments

        Issue Links

          contains

          Test - A new unit, integration or system test. SPARK-33242 Install numpydoc in Jenkins machines

          • Major - Major loss of function.
          • Resolved
          Dependent

          Improvement - An improvement or enhancement to an existing feature or task. SPARK-33247 Improve examples and scenarios in docstrings

          • Major - Major loss of function.
          • Resolved
          There are no Sub-Tasks for this issue.

          Activity

            People

              zero323 Maciej Szymkiewicz
              gurwls223 Hyukjin Kwon
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: