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

Pyspark sql function "format_string" has the wrong parameters in doc string

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Documentation
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 2.4.3
    • 2.3.4, 2.4.4, 3.0.0
    • PySpark
    • None

    Description

      The pyspark sql function "format_string" has a function declaration of "def _format_string(format, cols):*"_ However, the function's doc strings describes the parameters as:

       

      :param col: the column name of the numeric value to be formatted
      :param d: the N decimal places
      

       

      We want to update the doc string to accurately describe the parameters.

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            darrentirto Darren Tirto
            darrentirto Darren Tirto
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment