docs: fix non-compiling Rust session-limits example#2082
Merged
Conversation
The Rust tab of docs/features/session-limits.md called SessionConfig::new(), which does not exist -- SessionConfig is constructed via Default plus builder methods, so copying the example produced error[E0599]. Use SessionConfig::default() so the documented snippet compiles against the SDK it ships with. The neighboring resume example already uses the real ResumeSessionConfig::new(session_id) and is unchanged.
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes #2081 by correcting the non-compiling Rust session-limits example.
Changes:
- Replaces nonexistent
SessionConfig::new()with supportedSessionConfig::default().
Show a summary per file
| File | Description |
|---|---|
docs/features/session-limits.md |
Corrects Rust session construction. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Medium
SteveSandersonMS
approved these changes
Jul 27, 2026
This file contains hidden or 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
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.
Summary
The Rust example in the "Configure a session limit" section of
docs/features/session-limits.mddid not compile: it calledSessionConfig::new(), which does not exist.SessionConfigis constructed withSessionConfig::default()plus builder methods (the crate usesdefault()throughout; there is no
SessionConfig::new). This one-line change makes thedocumented snippet compile.
Fixes #2081
Change
docs/features/session-limits.md, Rust tab:Root cause
SessionConfig(rust/src/types.rs) implementsDefaultplus builder methodsbut has no
newassociated function, soSessionConfig::new()fails witherror[E0599]. The snippet was a mistranslation of the siblingTypeScript/Go/Java/.NET tabs, which all construct-then-configure. The block
carries
<!-- docs-validate: skip -->and Rust is not in the doc-validationlanguage set, so CI never compiled it. The neighboring resume example already
uses the real
ResumeSessionConfig::new(session_id)(a different type) and isleft unchanged.
Verification
Reproducer against the published crate:
Cargo.toml:src/main.rs: the documented snippet wrapped in the minimal#[tokio::main] async fn mainthe guide implies.cargo buildfails witherror[E0599]: no associated function ... named 'new' found for struct 'SessionConfig'.SessionConfig::new()->SessionConfig::default()):cargo buildfinishes clean.