Minor: Add Documentation and Examples to TableReference#5616
Merged
alamb merged 5 commits intoapache:mainfrom Mar 17, 2023
Merged
Minor: Add Documentation and Examples to TableReference#5616alamb merged 5 commits intoapache:mainfrom
TableReference#5616alamb merged 5 commits intoapache:mainfrom
Conversation
alamb
commented
Mar 15, 2023
| /// | ||
| /// # Creating [`TableReference`] | ||
| /// | ||
| /// When converting strings to [`TableReference`]s, the string is |
Contributor
Author
There was a problem hiding this comment.
The SQL parsing behavior added in #5343 is somewhat surprising so I think it should be well documented
Contributor
Author
|
FYI @Jefffrey |
Jefffrey
approved these changes
Mar 15, 2023
Contributor
Jefffrey
left a comment
Jefffrey
left a comment
There was a problem hiding this comment.
thanks for this, docs look good, just a few minor suggestions for being a bit more explicit about details
| } | ||
|
|
||
| /// Converts directly into an [`OwnedTableReference`] | ||
| /// Converts directly into an [`OwnedTableReference`] by copying |
Contributor
There was a problem hiding this comment.
copying -> cloning maybe?
not sure how explicit need to be about cloning in documentation
github-actions
bot
removed
the
documentation
Jefffrey
reviewed
Mar 15, 2023
alamb
commented
Mar 17, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Which issue does this PR close?
Related to #5615
Rationale for this change
While working on #5615 I realized how complicated the TableReference has become so I felt more documentataion was in order
What changes are included in this PR?
Add Documentation and Examples to
TableReferenceAre these changes tested?
Yes, doc tests are tested
Are there any user-facing changes?
More docs