Improve documentation of v_args meta option.
#1302
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
When using `@v_args(meta=True)`, visitor methods will receive a `meta` argument followed by a `children` argument in that order. The documentation previously described the arguments in the opposite order, which can be misleading to someone reading the docs, especially because there was no example of `@v_args(meta=True)`. This updates the documentation to describe the arguments in the order they are passed in to the visitor methods, and adds a new example for `@v_args(meta=True)`.
Member
|
Thanks, always glad to improve documentation. One nitpick - if we already give an example with |
Contributor
Author
|
No worries, just pushed up a new commit that adds an actual usage of the |
MegaIng
approved these changes
Jul 18, 2023
Member
|
Thanks! |
Contributor
Author
|
No problem, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
When using
@v_args(meta=True), visitor methods will receive ametaargument followed by achildrenargument in that order. The documentation previously described the arguments in the opposite order, which can be misleading to someone reading the docs, especially because there was no example of@v_args(meta=True).This updates the documentation to describe the arguments in the order they are passed in to the visitor methods, and adds a new example for
@v_args(meta=True).