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

Spark SQL functions documentation refers to SQL API documentation without linking to it

    XMLWordPrintableJSON

Details

    • Documentation
    • Status: Resolved
    • Trivial
    • Resolution: Fixed
    • 2.4.5
    • 3.3.0
    • Documentation
    • None

    Description

      Problem description

      The org.apache.spark.sql.functions documentation claims that:

      (...) You can find the entire list of functions at SQL API documentation.

      (...)

      regr_count is an example of a function that is built-in but not defined here, because it is less commonly used. To invoke it, use expr("regr_count(yCol, xCol)").

      Issue 1

      I had to roam a little bit to arrive at: https://spark.apache.org/docs/latest/api/sql/index.html. Is this the "SQL API documentation" to which the text refers? If so, I suggest adding this link there.

      Issue 2

      The documentation cites the function 'regr_count', but I couldn't find its documentation in the SQL API https://spark.apache.org/docs/latest/api/sql/index.html. The issue https://issues.apache.org/jira/browse/SPARK-23907 is related to this function. Where is the documentation for this function? 

       

      Attachments

        Activity

          People

            gcbeltramini Guilherme Beltramini
            gcbeltramini Guilherme Beltramini
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: