[GitHub] spark pull request #18026: [SPARK-16202][SQL][DOC] Follow-up to Correct The ...

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/spark/pull/18026


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #18026: [SPARK-16202][SQL][DOC] Follow-up to Correct The ...

[gatorsmile]

Github user gatorsmile commented on a diff in the pull request:

https://github.com/apache/spark/pull/18026#discussion_r117313888
  
--- Diff: 
sql/core/src/main/scala/org/apache/spark/sql/sources/interfaces.scala ---
@@ -163,16 +163,10 @@ trait StreamSinkProvider {
 @InterfaceStability.Stable
 trait CreatableRelationProvider {
   /**
-   * Save the DataFrame to the destination and return a relation with the 
given parameters based on
-   * the contents of the given DataFrame. The mode specifies the expected 
behavior of createRelation
-   * when data already exists.
-   * Right now, there are three modes, Append, Overwrite, and 
ErrorIfExists.
-   * Append mode means that when saving a DataFrame to a data source, if 
data already exists,
-   * contents of the DataFrame are expected to be appended to existing 
data.
-   * Overwrite mode means that when saving a DataFrame to a data source, 
if data already exists,
-   * existing data is expected to be overwritten by the contents of the 
DataFrame.
-   * ErrorIfExists mode means that when saving a DataFrame to a data 
source,
-   * if data already exists, an exception is expected to be thrown.
+   * Saves a DataFrame to a destination (using data source-specific 
parameters)
+   *
+   * @param mode specifies what happens when the destination already exists
+   * @param parameters data source-specific parameters
--- End diff --

Also add `@return`?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #18026: [SPARK-16202][SQL][DOC] Follow-up to Correct The ...

[gatorsmile]

Github user gatorsmile commented on a diff in the pull request:

https://github.com/apache/spark/pull/18026#discussion_r117312841
  
--- Diff: 
sql/core/src/main/scala/org/apache/spark/sql/sources/interfaces.scala ---
@@ -163,16 +163,10 @@ trait StreamSinkProvider {
 @InterfaceStability.Stable
 trait CreatableRelationProvider {
   /**
-   * Save the DataFrame to the destination and return a relation with the 
given parameters based on
-   * the contents of the given DataFrame. The mode specifies the expected 
behavior of createRelation
-   * when data already exists.
-   * Right now, there are three modes, Append, Overwrite, and 
ErrorIfExists.
-   * Append mode means that when saving a DataFrame to a data source, if 
data already exists,
-   * contents of the DataFrame are expected to be appended to existing 
data.
-   * Overwrite mode means that when saving a DataFrame to a data source, 
if data already exists,
-   * existing data is expected to be overwritten by the contents of the 
DataFrame.
-   * ErrorIfExists mode means that when saving a DataFrame to a data 
source,
-   * if data already exists, an exception is expected to be thrown.
+   * Saves a DataFrame to a destination (using data source-specific 
parameters)
+   *
+   * @param mode specifies what happens when the destination already exists
+   * @param parameters data source-specific parameters
--- End diff --

Could you add the descriptions for the other two parameters here? Thanks!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

[GitHub] spark pull request #18026: [SPARK-16202][SQL][DOC] Follow-up to Correct The ...

[jaceklaskowski]

GitHub user jaceklaskowski opened a pull request:

https://github.com/apache/spark/pull/18026

[SPARK-16202][SQL][DOC] Follow-up to Correct The Description of 
CreatableRelationProvider's createRelation

## What changes were proposed in this pull request?

Follow-up to SPARK-16202:

1. Remove the duplication of the meaning of `SaveMode` (as one was in fact 
missing that had proven that the duplication may be incomplete in the future 
again)

2. Use standard scaladoc tags

/cc @gatorsmile @rxin @yhuai (as they were involved previously)

## How was this patch tested?

local build

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/jaceklaskowski/spark 
CreatableRelationProvider-SPARK-16202

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/spark/pull/18026.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #18026


commit 7bf5d1962aa750079da313cd6d106bf8c616d448
Author: Jacek Laskowski 
Date:   2017-05-18T07:56:28Z

[SPARK-16202][SQL][DOC] Follow-up to Correct The Description of 
CreatableRelationProvider's createRelation




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org