Repository navigation
docs: distinguish tree positions from prefixes - #245
Merged
davidhalter merged 1 commit intoSep 22, 2026
Merged
davidhalter merged 1 commit into
davidhalter merged 1 commit into
Conversation
Owner
|
Thanks |
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.
The parser-tree API docstrings describe
start_posandend_posas positions of the prefix, although the implementations report the node or token boundaries. They also describeinclude_prefixas removing the prefix without explaining that this happens when it is false.Distinguish node/leaf positions from prefix positions, correct the existing
+example's terminology, and explain thatget_code(include_prefix=False)removes only the leading prefix while retaining prefixes inside a node. Add a documentation contributor entry as requested by CONTRIBUTING.Validation: statically reviewed the
LeafandBaseNodeimplementations and existing tree/code-preservation assertions. Python ASTs are identical after removing docstrings; exact original blobs and the diff were checked. No parso import, test suite, Sphinx build or project script was run. This changes four API docstrings and AUTHORS only.Prepared with AI assistance (OpenAI Codex), with source and diff review.