docs: simplify session_settings override wording#3634
Conversation
- Rephrase the `RunConfig.session_settings` explanation to make the per-run override behavior easier to understand. - This keeps the meaning the same while reducing ambiguity around how default session limits interact with per-run settings.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f26bdd7805
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| ``` | ||
|
|
||
| If your session implementation exposes default session settings, `RunConfig.session_settings` overrides any non-`None` values for that run. This is useful for long conversations where you want to cap retrieval size without changing the session's default behavior. | ||
| If your session backend has default history limits configured, passing `session_settings` in `RunConfig` overrides them for that specific run. This is useful for long conversations where you want to temporarily cap retrieval size without changing the session's default behavior. |
There was a problem hiding this comment.
When a session backend has a default limit and the caller passes RunConfig(session_settings=SessionSettings(limit=None)) expecting to retrieve all history, this wording now says the per-run settings override the backend limits. The runtime resolves settings by overlaying only non-None values (SessionSettings.resolve()), so limit=None leaves the backend default limit in place; users following the preceding SessionSettings(limit=None) note may still get capped history unless the caveat is kept.
Useful? React with 👍 / 👎.
- Reword the `RunConfig.session_settings` explanation while keeping the non-`None` override behavior explicit. - This keeps the docs accurate for cases where `SessionSettings(limit=None)` should not be read as overriding a backend default limit.
2 participants
Rephrase the
RunConfig.session_settingsexplanation to make the per-run override behavior easier to understand.This keeps the meaning the same while reducing ambiguity around how default session limits interact with per-run settings.