Minor: Improve API docs for FlightSQL metadata builders #4667
Conversation
This file contains 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
github-actions
bot
added
arrow
alamb
commented
Aug 8, 2023
| @@ -334,8 +334,8 @@ impl SqlInfoUnionBuilder { | |||
| /// [`CommandGetSqlInfo`] are metadata requests used by a Flight SQL | |||
| /// server to communicate supported capabilities to Flight SQL clients. | |||
| /// | |||
| /// Servers constuct - usually static - [`SqlInfoData`] via the [SqlInfoDataBuilder`], | |||
There was a problem hiding this comment.
the missing backtick causes this to be rendered incorrectly:
https://docs.rs/arrow-flight/45.0.0/arrow_flight/sql/metadata/struct.XdbcTypeInfoData.html
And it turns out GetSqlInfoBuiler is private but that was not caught because of the bad back ticking
tustvold
approved these changes
Aug 9, 2023
|
cc @roeap |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
N/a
Rationale for this change
When updating IOx to use some of these APIs in https://github.com/influxdata/influxdb_iox/pull/8455 and https://github.com/influxdata/influxdb_iox/pull/8453 I notices some documentation inconsistencies.
What changes are included in this PR?
Update doc APIs
Are there any user-facing changes?
better docs