Minor: improve documentation on SessionState
#11642
Merged
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
alamb
commented
Jul 24, 2024
| /// See [`SessionContext`] for a higher level API. | ||
| /// `SessionState` contains all the necessary state to plan and execute queries, | ||
| /// such as configuration, functions, and runtime environment. Please see the | ||
| /// documentation on [`SessionContext`] for more information. |
There was a problem hiding this comment.
I wanted to make it clear that SessionContext not only has a higher level API it also has a good description of the differences between the structures:
alamb
changed the title
SessionState
findepi
approved these changes
Jul 26, 2024
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
While working on trying to add some doc suggestions to #11516 (which is basically making a trait for
SessionState), I reviewed the SessionState documentation and found some thing I would like to clarifyWhat changes are included in this PR?
SessionStatefromSessionContextAre these changes tested?
yes, by doc test in CI
Are there any user-facing changes?
Only documentation, no user facing changes