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

Two doctest fixes #4366

Merged
merged 8 commits into from
Dec 21, 2023
Merged

Two doctest fixes #4366

merged 8 commits into from
Dec 21, 2023

Conversation

ljwoods2
Copy link
Contributor

@ljwoods2 ljwoods2 commented Dec 15, 2023

Fixes #3925

Changes made in this Pull Request:

  • Fixed doctests in overview.rst
  • Fixed doctests in atomicdistances.py

PR Checklist

  • Tests?
  • Docs?
  • Issue raised/referenced?

Developers certificate of origin


📚 Documentation preview 📚: https://mdanalysis--4366.org.readthedocs.build/en/4366/

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello there first time contributor! Welcome to the MDAnalysis community! We ask that all contributors abide by our Code of Conduct and that first time contributors introduce themselves on the developer mailing list so we can get to know you. You can learn more about participating here. Please also add yourself to package/AUTHORS as part of this PR.

Copy link

github-actions bot commented Dec 15, 2023

Linter Bot Results:

Hi @ljwoods2! Thanks for making this PR. We linted your code and found the following:

There are currently no issues detected! 🎉

Copy link

codecov bot commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (809ade8) 93.41% compared to head (33ca37c) 93.41%.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop    #4366     +/-   ##
==========================================
  Coverage    93.41%   93.41%             
==========================================
  Files          171      185     +14     
  Lines        22512    23625   +1113     
  Branches      4129     4129             
==========================================
+ Hits         21029    22069   +1040     
- Misses         963     1036     +73     
  Partials       520      520             

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

@JoStoe JoStoe mentioned this pull request Dec 16, 2023
5 tasks
Copy link
Member

@RMeli RMeli left a comment

Choose a reason for hiding this comment

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

Thanks @ljwoods2, LGTM. Please update the CHANGELOG, then I think it's good to go.

@RMeli
Copy link
Member

RMeli commented Dec 17, 2023

Thanks @ljwoods2. Can you please also add a line explaining the fix to the CHANGELOG, under the "Fixes" entry?

@ljwoods2 ljwoods2 requested a review from RMeli December 18, 2023 18:39
@RMeli
Copy link
Member

RMeli commented Dec 19, 2023

Thanks @ljwoods2. Please solve the conflicts, the AUTHORS and CHANGELOG files have been modified in the meantime.

@RMeli RMeli self-assigned this Dec 19, 2023
@ljwoods2
Copy link
Contributor Author

@RMeli Got it, thank you for being patient and explaining the process!

@RMeli RMeli merged commit abee0bb into MDAnalysis:develop Dec 21, 2023
23 checks passed
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.

[DOC] doctest MEGA-issue
2 participants