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

Migrate to NumPy documentation style

    XMLWordPrintableJSON

    Details

    • Type: Umbrella
    • Status: Resolved
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: 3.1.0
    • Fix Version/s: 3.1.0
    • Component/s: PySpark
    • Labels:
      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

            Activity

              People

              • Assignee:
                zero323 Maciej Szymkiewicz
                Reporter:
                hyukjin.kwon Hyukjin Kwon
              • Votes:
                1 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: