MyST-Parser icon indicating copy to clipboard operation
MyST-Parser copied to clipboard

πŸ› FIX: don't fail with docutils 0.19

Open flokli opened this issue 3 years ago β€’ 3 comments

Update the version bounds to allow docutils 0.19, and update the fixtures to match the output produced by 0.19.

Fixes https://github.com/executablebooks/MyST-Parser/issues/591.

flokli avatar Aug 04 '22 07:08 flokli

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

welcome[bot] avatar Aug 04 '22 07:08 welcome[bot]

As written in https://github.com/executablebooks/MyST-Parser/issues/591#issuecomment-1204861447, this now bumps the required version to 0.19. I'm not sure how to conditionally update the fixture contents to the output docutils 0.19 presents, only when docutils >0.19 is available.

I've seen a similar PR at https://github.com/executablebooks/MyST-Parser/pull/478 that patches the fixtures, but it looks like it's not patched conditionally. Did the tests with older versions just fail?

flokli avatar Aug 04 '22 07:08 flokli

Codecov Report

Merging #606 (aa31ec6) into master (7556122) will decrease coverage by 0.09%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #606      +/-   ##
==========================================
- Coverage   89.86%   89.77%   -0.10%     
==========================================
  Files          21       21              
  Lines        2122     2122              
==========================================
- Hits         1907     1905       -2     
- Misses        215      217       +2     
Flag Coverage Ξ”
pytests 89.77% <ΓΈ> (-0.10%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Ξ”
myst_parser/mocking.py 86.27% <0.00%> (-0.79%) :arrow_down:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

codecov[bot] avatar Aug 04 '22 07:08 codecov[bot]

@flokli Any chance you could bring this PR to a form that could be merged? ... as in passing CI.

I am sure lots of us want to upgrade docutils, even if it might prove to be better to find a solution that does not drop support for older versions, as it is likely to cause impossible to address dependency conflicts with other docutils consumers.

ssbarnea avatar Aug 14 '22 21:08 ssbarnea

This PR was mostly intended to show what has changed with later versions of docutils. I still need some feedback from maintainers on how to proceed with this, as written in https://github.com/executablebooks/MyST-Parser/pull/606#issuecomment-1204873961.

flokli avatar Aug 15 '22 11:08 flokli

superceded by #611

chrisjsewell avatar Aug 15 '22 17:08 chrisjsewell