sergiocorreia / panflute

An Pythonic alternative to John MacFarlane's pandocfilters, with extra helper functions
http://scorreia.com/software/panflute/
BSD 3-Clause "New" or "Revised" License
500 stars 59 forks source link

Test and document list returning behavior for action functions #200

Closed jacobwhall closed 2 years ago

jacobwhall commented 3 years ago

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.

jacobwhall commented 2 years ago

@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.

ickc commented 2 years ago

@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?