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(#173): add config option to prevent clobbering user's numbered fo… #192

Merged
merged 3 commits into from
Jun 6, 2023

Conversation

daylinmorgan
Copy link
Contributor

…otnotes

Exposes a new config option to define the footnote format:

... 
plugins:
  - search
  - bibtex:
      bib_file: "refs.bib"
      footnote_format: "ref{number}" # default "{number}"
...

@codecov
Copy link

codecov bot commented May 20, 2023

Codecov Report

Patch coverage: 83.33% and project coverage change: -0.52 ⚠️

Comparison is base (b87ab9b) 98.24% compared to head (b8ef581) 97.72%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #192      +/-   ##
==========================================
- Coverage   98.24%   97.72%   -0.52%     
==========================================
  Files           3        3              
  Lines         171      176       +5     
==========================================
+ Hits          168      172       +4     
- Misses          3        4       +1     
Impacted Files Coverage Δ
src/mkdocs_bibtex/plugin.py 95.94% <83.33%> (-1.16%) ⬇️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@shyamd
Copy link
Owner

shyamd commented May 20, 2023

Thanks for taking a stab at this. The code looks clean and correct.

Can you add in a test case for:

  • __init__ throwing an error on a invalid format and not on valid one
  • format_footnote
  • add another case to format_citations to check that the formatting is working correctly on the final product

@daylinmorgan
Copy link
Contributor Author

I've been super busy thanks for rounding this out!

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