Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 Fix docutils deprecation in option parsing #842

Merged
merged 4 commits into from
Dec 19, 2023

Conversation

agoose77
Copy link
Contributor

This PR fixes the deprecation warnings raised by docutils' deprecation of OptionParser.

The help handling is a little ugly - we could introduce a switch on the docutils version like we do for the default settings. However, I think this approach will be less likely to break once the breaking change is introduced.

Copy link

welcome bot commented Dec 12, 2023

Thanks for submitting your first pull request! You are awesome! 🤗

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! 🎉

pyproject.toml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 12, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (b445a0c) 90.08% compared to head (80e4b6a) 90.04%.

Files Patch % Lines
myst_parser/mdit_to_docutils/base.py 66.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #842      +/-   ##
==========================================
- Coverage   90.08%   90.04%   -0.05%     
==========================================
  Files          24       24              
  Lines        3360     3364       +4     
==========================================
+ Hits         3027     3029       +2     
- Misses        333      335       +2     
Flag Coverage Δ
pytests 90.04% <66.66%> (-0.05%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@chrisjsewell
Copy link
Member

chrisjsewell commented Dec 13, 2023

Cheers @agoose77!

Note some suggestions on a fix were given here: #612 (comment), maybe you want to double check that against your changes here?

Will have a proper look later

@chrisjsewell chrisjsewell linked an issue Dec 13, 2023 that may be closed by this pull request
@agoose77
Copy link
Contributor Author

Thanks @chrisjsewell — I actually used that issue as a starting point. As such, I'm hopeful that this should fall in line with the recommended changes where possible.

@chrisjsewell chrisjsewell changed the title MAINT: update for deprecated option parsing 🔧 Fix docutils deprecation in option parsing Dec 19, 2023
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep I think all good cheers

@chrisjsewell chrisjsewell merged commit 45c5042 into master Dec 19, 2023
21 checks passed
@chrisjsewell chrisjsewell deleted the agoose77/maint-deprecated-option-parser branch December 19, 2023 09:37
Copy link

welcome bot commented Dec 19, 2023

Congrats on your first merged pull request in this project! 🎉
congrats

Thank you for contributing, we are very proud of you! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix docutils 0.19 deprecation warnings
2 participants