Test and document list returning behavior for action functions #200
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
- tests for Element.walk() to understand how it handles lists returned by action functions
- documenting ability for action functions to return lists of block or inline elements - various spelling and capitalization fixes
sergiocorreia
approved these changes
Nov 22, 2021
|
@sergiocorreia It looks like the pytest step failed for the build GitHub Action for this PR. I'd be happy to help look into it. |
|
@jacobwhall, the failure may be related to compatibility issues with newer pandoc versions. But I wonder why this pull request doesn't has a GitHub Actions build? |
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.
We may want to consider allowing lists of MetaValues to be returned, though in my opinion it makes more sense to return a MetaList in those situations.
In #199, @ickc suggested that if action functions return a single element, that element should always be in a list, and that we should only allow standalone elements to be returned for compatibility reasons. Because of the difference between Block/Inline and MetaValue lists I described above, I'm not sure what would be best. I tried to write this documentation change to best reflect the current behavior of Panflute.
As a new contributor to this project (and in general), I welcome any feedback! Thank you for your time.