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

API Documentation issue for org.apache.spark.sql.streaming.Trigger

    Details

    • Type: Bug
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.6.3, 2.0.0, 2.2.0, 2.2.1
    • Fix Version/s: None
    • Component/s: Documentation, Java API
    • Labels:

      Description

      1) Trigger.java link is broken in the documentation - https://spark.apache.org/docs/2.2.0/api/scala/index.html#org.apache.spark.sql.streaming.Trigger.
      The link redirect to: https://github.com/apache/spark/tree/v2.2.0/sql/core/src/main/java/org/apache/spark/sql/streaming/Trigger.java.scala and results in 404 error.
      Notice Trigger.java.scala. It should be Trigger.java

      So, the correct link is https://github.com/apache/spark/tree/v2.2.0/sql/core/src/main/java/org/apache/spark/sql/streaming/Trigger.java

      2) Because of the above issue, org.apache.spark.sql.streaming.Trigger has incomplete documentation. See https://spark.apache.org/docs/2.2.0/api/scala/index.html#org.apache.spark.sql.streaming.Trigger. As a result, Public methods such as ProcessingTime() isn't documented.

      Update - 01/03/2018: It looks like all .java files referenced in Scala API documentation suffer from this problem. For example - SaveMode also has a broken link - https://github.com/apache/spark/tree/v2.2.0/sql/core/src/main/java/org/apache/spark/sql/SaveMode.java.scala

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              ganeshchand Ganesh Chand
            • Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: