docs: note the minimum language runtimes in the bundled CLI quick start - #2312
Open
rinceyuan wants to merge 1 commit into
Open
docs: note the minimum language runtimes in the bundled CLI quick start#2312rinceyuan wants to merge 1 commit into
rinceyuan wants to merge 1 commit into
Conversation
The quick start jumps straight to code with no version requirements. On a Python older than the declared 3.11 floor, pip resolves to an outdated SDK release instead of reporting the conflict, so the snippet fails with an error that says nothing about the Python version. Fixes github#2293.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds minimum supported runtime requirements to the bundled CLI quick start, helping prevent unsupported Python installations from resolving an outdated SDK.
Changes:
- Lists minimum runtimes for all supported SDK languages.
- Explains Python’s silent fallback behavior and links to prerequisites.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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 bundled CLI quick start goes straight from install to code with no statement of the supported language runtimes, so nothing warns a reader who is on an unsupported one.
For Python this fails in a way that gives no hint about the cause. The package declares
requires-python = ">=3.11", so on 3.10pipdoes not report a conflict - it silently resolves to an old pre-3.11 SDK release. The quick start snippet then blows up inside that old release with an error that never mentions the Python version (AttributeError: type object 'Callable' has no attribute 'approve_all'in the linked issue).This adds a note above the language tabs listing the same minimum runtimes already stated in the getting-started tutorial, and links there.
Notes
Prerequisitessection ofdocs/getting-started.md; the Python floor matchesrequires-pythoninpython/pyproject.toml.<details>group, per the multi-language rule in the docs style guide.docs-validatebehaviour is unchanged.Fixes #2293.