Mention internal/external transformers in the documentation #1486
Conversation
This file contains 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
Helps users not fall into a problem similar to lark-parser#408.
erezsh
reviewed
Nov 13, 2024
lark/visitors.py
Outdated
| @@ -523,7 +523,7 @@ def v_args(inline: bool = False, meta: bool = False, tree: bool = False, wrapper | |||
|
|
|||
| Parameters: | |||
| inline (bool, optional): Children are provided as ``*args`` instead of a list argument (not recommended for very long lists). | |||
| meta (bool, optional): Provides two arguments: ``meta`` and ``children`` (instead of just the latter) | |||
| meta (bool, optional): Provides two arguments: ``meta`` and ``children`` (instead of just the latter); ``meta`` is only available for external transformers (i.e., those not supplied as ``Lark``'s ``transformer`` parameter). | |||
There was a problem hiding this comment.
What if we phrase it as
``meta`` isn't available for transformers supplied to Lark using the ``transformer`` parameter (aka internal transformers).
There was a problem hiding this comment.
Certainly sounds better/is more direct. I've changed it!
|
Thanks for contributing! |
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.
Helps users not fall into a problem similar to #408 — which I recently did.
I'm sure the actual text could be improved; feel free to modify it to taste, but I do think it would be helpful to have this or something similar in the docs. Thanks for the library!