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

Refactor plugin for more modularity #104

Merged
merged 23 commits into from
Jan 20, 2022
Merged

Refactor plugin for more modularity #104

merged 23 commits into from
Jan 20, 2022

Conversation

shyamd
Copy link
Owner

@shyamd shyamd commented Jan 20, 2022

This PR is a major refactor of the plugin. It does have some breaking changes, so will likely be a major version update.

  • Moves a lot of the functionality into functions in utils to make the logic easier to read
  • Handle simple vs pandoc formatting with two different functions to keep them cleaner
  • Update python package style and testing for future compatibility
  • Manual unescape_for_arithmatex was removed in favor of always fixing this issue when using the pybtex backend. Pandoc doesn't seem to have this problem.

@codecov-commenter
Copy link

codecov-commenter commented Jan 20, 2022

Codecov Report

Merging #104 (1f198ea) into master (7bf655e) will increase coverage by 3.25%.
The diff coverage is 97.60%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #104      +/-   ##
==========================================
+ Coverage   92.92%   96.18%   +3.25%     
==========================================
  Files           2        3       +1     
  Lines          99      131      +32     
==========================================
+ Hits           92      126      +34     
+ Misses          7        5       -2     
Impacted Files Coverage Δ
src/mkdocs_bibtex/__init__.py 66.66% <ø> (ø)
src/mkdocs_bibtex/utils.py 97.01% <97.01%> (ø)
src/mkdocs_bibtex/plugin.py 98.27% <98.27%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7bf655e...1f198ea. Read the comment docs.

@shyamd shyamd merged commit 8f73346 into master Jan 20, 2022
@shyamd shyamd deleted the update-python-compat branch February 21, 2022 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants