You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Ganesh Chand (JIRA)" <ji...@apache.org> on 2018/01/03 22:01:05 UTC
[jira] [Updated] (SPARK-22928) API Documentation issue for
org.apache.spark.sql.streaming.Trigger
[ https://issues.apache.org/jira/browse/SPARK-22928?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ganesh Chand updated SPARK-22928:
---------------------------------
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
was:
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.
> API Documentation issue for org.apache.spark.sql.streaming.Trigger
> ------------------------------------------------------------------
>
> Key: SPARK-22928
> URL: https://issues.apache.org/jira/browse/SPARK-22928
> Project: Spark
> Issue Type: Bug
> Components: Documentation, Java API
> Affects Versions: 2.2.0
> Reporter: Ganesh Chand
> Labels: docuentation
>
> 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
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org