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

Sort entries in the pyspark API reference docs alphabetically

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Trivial
    • Resolution: Unresolved
    • 3.3.0, 3.3.1, 3.2.4, 3.3.2, 3.4.0
    • None
    • Documentation
    • None

    Description

      Currently the methods on a lot of api reference docs are nor sorted which makes navigation quite hard and unintuitive, e.g. https://spark.apache.org/docs/latest/api/python/reference/pyspark.pandas/series.html#reindexing-selection-label-manipulation

      has the following order:

      Series.equals(other) Compare if the current value is equal to the other.
      Series.add_prefix(prefix) Prefix labels with string prefix.
      Series.add_suffix(suffix) Suffix labels with string suffix.
      Series.first(offset) Select first periods of time series data based on a date offset.
      Series.head([n])

       

      Ideally the methods should be sorted alphabetically to make navigating the docs predictable.

      Attachments

        Activity

          People

            Unassigned Unassigned
            lukasz.mentel Lukasz Mentel
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: