Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: improve TableReference docs #9952

Merged
merged 3 commits into from
Apr 5, 2024
Merged

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Apr 4, 2024

Which issue does this PR close?

Rationale for this change

While reviewing #9933 from @comphead I noticed a few things that could be improved in the docs

What changes are included in this PR?

Improve TableReferenc docs

Are these changes tested?

Doc tests

Are there any user-facing changes?

Better docs

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm thanks @alamb

Copy link
Contributor

@Jefffrey Jefffrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@@ -139,7 +142,7 @@ impl TableReference {

/// Convenience method for creating a [`TableReference::Partial`].
///
/// As described on [`TableReference`] this does *NO* parsing at all.
/// As described on [`TableReference`] this does *NO* normalization at all.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: technically the doc on TableReference doesn't make reference to partial or full functions as it only refers to bare

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a good call -- I have clarified in a1d5965. Thank you @Jefffrey

@alamb alamb merged commit d5f7ce3 into apache:main Apr 5, 2024
24 checks passed
@alamb
Copy link
Contributor Author

alamb commented Apr 5, 2024

Thanks again @comphead and @Jefffrey

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants