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

Update guesser docs #4743

Merged
merged 6 commits into from
Oct 20, 2024

Conversation

lilyminium
Copy link
Member

@lilyminium lilyminium commented Oct 19, 2024

Fixes #4696

Changes made in this Pull Request:

  • This adds back the documentation on guessed attributes as a note, whereever the previous guessed attribute documentation was (this varied between the module docs and class docs). The note contains a link to the overall guesser docs
  • The overall guesser docs contain more info about the default guessing involved.

Please feel free to make any changes desired and push into this branch!

PR Checklist

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

Developers certificate of origin


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

@pep8speaks
Copy link

pep8speaks commented Oct 19, 2024

Hello @lilyminium! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 317:1: W293 blank line contains whitespace

Comment last updated at 2024-10-19 23:43:09 UTC

@lilyminium lilyminium added this to the Release 2.8.0 milestone Oct 19, 2024
Copy link

codecov bot commented Oct 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.62%. Comparing base (9b69745) to head (5b999a4).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4743      +/-   ##
===========================================
- Coverage    93.65%   93.62%   -0.03%     
===========================================
  Files          175      187      +12     
  Lines        21564    22630    +1066     
  Branches      3023     3023              
===========================================
+ Hits         20195    21188     +993     
- Misses         925      998      +73     
  Partials       444      444              

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

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Just the one suggestion, otherwise lgtm. Thanks.

package/MDAnalysis/guesser/default_guesser.py Show resolved Hide resolved
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
@lilyminium lilyminium merged commit 101008b into MDAnalysis:develop Oct 20, 2024
23 of 24 checks passed
@lilyminium lilyminium deleted the document-guessed-attributes branch October 20, 2024 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documenting guessed attributes
3 participants