[MINOR][Documentation] Mention that short names can be used in data sources not only for built-in sources #15540
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Test build #67158 has finished for PR 15540 at commit
|
rxin
reviewed
Oct 19, 2016
| names (`json`, `parquet`, `jdbc`, `orc`, `libsvm`, `csv`, `text`). DataFrames loaded from any data | ||
| source type can be converted into other types using this syntax. | ||
| name (i.e., `org.apache.spark.sql.parquet`) or short name specified in | ||
| `DataSourceRegister.shortName()` in their implementation. For built-in sources you can use their |
Contributor
There was a problem hiding this comment.
hm this isn't clear to the end user at all, since there is no class called DataSourceRegister even in the source code for data sources. I'd just leave it out. It should be the job of the data source to tell users how to use it.
Member
Author
There was a problem hiding this comment.
Makes sense. Thank you for your quick response.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR proposes to fix the documentation in order to mention the short names can be used for other external data sources as well (not only built-in ones).
How was this patch tested?
Manually built the docs.
Before
After