chore: Update api docs for SessionContext, TaskContext, etc
#6106
Conversation
github-actions
bot
added
core
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| //! This module contains the shared state available at different parts |
There was a problem hiding this comment.
this was hard to find, so I moved the content on to the structs that were referenced
| /// Execution runtime environment. | ||
| /// | ||
| /// A [`RuntimeEnv`] can be created from a [`RuntimeConfig`] and | ||
| /// stores state to be shared across multiple sessions. In most |
There was a problem hiding this comment.
Probably I'm wrong here, but not sure RuntimeEnv is shared between sessions.
The runtime will be shared between queries within single session.
But SessionContext::new() creates new session with new UUID and new runtime.
There was a problem hiding this comment.
This is a good point -- by default a SessionContext creates a new instance of RuntimeEnv -- however that means any limits are not enforced across queries. I think this comment was trying to say if you want limits enforced across multiple session contexts you need to use the same RuntimeEnv
I have tried to clarify this in 0bbf687
| /// `RuntimeEnv`, and therefore will not enforce memory or disk | ||
| /// limits for queries run on different `SessionContext`s. | ||
| /// | ||
| /// To enforce resource limits (e.g. to limit the total amount of |
3 participants
Which issue does this PR close?
Related to #3058
Rationale for this change
I am trying to make the API docs published to crates.io more useful and stand on their own
What changes are included in this PR?
SessionContextand consolidate some other docs from theexecutionmodule that were hard to discoverAre these changes tested?
Yes (with CI checks)
Are there any user-facing changes?
Hopefully better docs