docs: fix demo.py usage paths#89
Open
Offwhite-Del wants to merge 1 commit into
Open
Conversation
The script lives at the repository root, so make the four copy-paste examples executable from the documented working directory.
Offwhite-Del
force-pushed
the
fix/demo-docstring-path
branch
from
July 22, 2026 03:21
9360b04 to
7c4202e
Compare
Offwhite-Del
changed the title
styop97
approved these changes
Jul 24, 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
2 participants
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
Correct the four usage examples in the module docstring so they invoke the script at its actual repository-root path.
Why
demo.pyis at the repository root; there is noexamples/demo.py. Copying any of the previous commands therefore failed before argument parsing.Validation
python demo.py.examples/demo.pyreference remains in the docstring.main; the PR now changes onlydemo.py.