Repository navigation
docs: make the Python reference first run self-contained - #17
Merged
Merged
Conversation
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
1 participant
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.
The first tour assumed an existing checkout, development extras and Make. Replace that starting point with complete Linux/macOS and Windows PowerShell steps to clone the repository, create a virtual environment and install the ordinary runtime package.
Run doctor, demo and the SQL list with the environment's Python, describe the expected Python reference backend and terminal output, and give a single-report command with its two HTML paths. Keep native C++ and Make as optional development routes.
Validation: the documented CLI arguments passed in an existing Windows Python 3.12 environment, including two commands outside the checkout; the demo has eight rows, the SQL list has seven entries and both HTML files exist. All 15 existing documentation tests pass. Independent review checked the Linux/Windows snippets against the CLI; the Unix interpreter path was not locally executed on Windows. Runtime code, dependencies, examples and CI are unchanged.