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: align.py doctest error #4521

Merged
merged 3 commits into from
Mar 29, 2024
Merged

Conversation

talagayev
Copy link
Member

@talagayev talagayev commented Mar 20, 2024

Partially Fixes #3925

Changes made in this Pull Request:

  • Doctest for align.py
    (package/MDAnalysis/analysis/align.py) file contains these errors:

    • NameError: name rmsd is not defined: Reason were typo errors, which required to add :: in the end of two sentences to fix

PR Checklist

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

Developers certificate of origin


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

@talagayev talagayev changed the title added :: in the end of two sentences, to remove two "not defined" errors Fix: align.py doctest error Mar 20, 2024
Copy link

github-actions bot commented Mar 20, 2024

Linter Bot Results:

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

Some issues were found with the formatting of your code.

Code Location Outcome
main package ⚠️ Possible failure
testsuite ✅ Passed

Please have a look at the darker-main-code and darker-test-code steps here for more details: https://github.com/MDAnalysis/mdanalysis/actions/runs/8485462548/job/23250291531


Please note: The black linter is purely informational, you can safely ignore these outcomes if there are no flake8 failures!

Copy link

codecov bot commented Mar 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.66%. Comparing base (ff222fe) to head (9f27f9a).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4521   +/-   ##
========================================
  Coverage    93.66%   93.66%           
========================================
  Files          168      168           
  Lines        21240    21240           
  Branches      3913     3913           
========================================
  Hits         19894    19894           
  Misses         888      888           
  Partials       458      458           

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

@orbeckst orbeckst enabled auto-merge (squash) March 29, 2024 20:40
Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

LGTM, just add yourself to AUTHORS. (We don't need an entry for CHANGELOG for doctest fixes)

@orbeckst orbeckst self-assigned this Mar 29, 2024
auto-merge was automatically disabled March 29, 2024 20:53

Head branch was pushed to by a user without write access

@talagayev
Copy link
Member Author

LGTM, just add yourself to AUTHORS. (We don't need an entry for CHANGELOG for doctest fixes)

Added myself to AUTHORS list

@orbeckst orbeckst enabled auto-merge (squash) March 29, 2024 21:12
@orbeckst orbeckst merged commit 3cbbab5 into MDAnalysis:develop Mar 29, 2024
15 of 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