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

Explicitly specify UTF-8 for citation generation #2578

Merged
merged 3 commits into from Mar 12, 2024

Conversation

JaydenR2305
Copy link
Member

@JaydenR2305 JaydenR2305 commented Mar 12, 2024

Declares encoding="utf-8" for reading the CITATIONS.cff file. For one reason or another, machines don't always default to this encoding, using instead something like cp1252. These machine-dependent encoding standards are usually incapable of reading certain characters. Explicitly specifying UTF-8 encoding will ensure documentation can be built regardless of a user's operating system.

@JaydenR2305 JaydenR2305 requested a review from a team as a code owner March 12, 2024 15:19
@JaydenR2305 JaydenR2305 requested review from ejohnson-96 and removed request for a team March 12, 2024 15:19
Copy link

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:

  • Try fixing CI / Python 3.12 test failures first.
  • Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer. Please also see our pre-commit troubleshooting guide.
  • If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
  • If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
  • For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples.

We thank you once again!

@github-actions github-actions bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Mar 12, 2024
@github-actions github-actions bot added the bug Issues describing unexpected behavior or defects. Remember: a bug is a sign of a missing test! label Mar 12, 2024
Copy link

codecov bot commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.71%. Comparing base (20e60aa) to head (0fa8905).
Report is 70 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2578      +/-   ##
==========================================
- Coverage   96.93%   96.71%   -0.23%     
==========================================
  Files         104      104              
  Lines        9163     9365     +202     
==========================================
+ Hits         8882     9057     +175     
- Misses        281      308      +27     

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

Copy link
Member

@namurphy namurphy left a comment

Choose a reason for hiding this comment

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

Good catch! LGTM!

@namurphy namurphy merged commit faef2a2 into PlasmaPy:main Mar 12, 2024
18 checks passed
@JaydenR2305 JaydenR2305 deleted the windows-documentation-build branch March 14, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues describing unexpected behavior or defects. Remember: a bug is a sign of a missing test! docs PlasmaPy Docs at http://docs.plasmapy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants