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

MDAnalysis.analysis.rms.rmsd docs fixed version entries #4022

Merged
merged 5 commits into from
Feb 13, 2023

Conversation

MeetB7
Copy link
Contributor

@MeetB7 MeetB7 commented Feb 10, 2023

Fixes #4014

Changes made in this Pull Request:

  • syntax error in version entries

PR Checklist

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

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.

@codecov
Copy link

codecov bot commented Feb 10, 2023

Codecov Report

Base: 93.52% // Head: 93.52% // No change to project coverage 👍

Coverage data is based on head (7a095c5) compared to base (e8cebb2).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4022   +/-   ##
========================================
  Coverage    93.52%   93.52%           
========================================
  Files          190      190           
  Lines        25028    25028           
  Branches      3542     3542           
========================================
  Hits         23407    23407           
  Misses        1100     1100           
  Partials       521      521           
Impacted Files Coverage Δ
package/MDAnalysis/analysis/rms.py 93.02% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

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.

Hi @MeetB7 , this looks good, nice and clean work! 👍

Please also do the following

  • add yourself to the AUTHORS file
  • add your GitHub handle to the top of CHANGELOG (where you see the other people who contributed to the 2.5.0 release); you don't need an entry but you should be credited as a contributor
  • introduce yourself on the mdanalysis-developer list, please (reference this PR in your message), see https://www.mdanalysis.org/#participating

Please ping me with @orbeckst when you've done everything. This will notify me, otherwise I might not remember to look at the PR (sorry, I am busy with many different things)

Once you've done all of the above, I can merge your first contribution!

@orbeckst
Copy link
Member

Hi @MeetB7 , please also add yourself to CHANGELOG and Resolve the conflicts. Otherwise it cannot be merged.

@MeetB7
Copy link
Contributor Author

MeetB7 commented Feb 13, 2023

Hey @orbeckst i have made the changes and my pr is ready to merge.
Thank you!!
Ps: sorry for delay

@MeetB7 MeetB7 requested review from orbeckst and removed request for orbeckst February 13, 2023 05:00
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.

  • Did you check the built docs and visually confirmed that the version changed now show up? There's a read the docs check that leads you to the built docs. Please paste the link to the page where the rmsd docs are displayed and confirm that it looks good.

  • There's one line break issue in the CHANGELOG. I created a suggestion for a fix. Just commit my suggestion by pressing the nice "Commit suggestion" button.

Looks good to me, thank you, I am just waiting for you to do the two things.

package/CHANGELOG Outdated Show resolved Hide resolved
@orbeckst
Copy link
Member

To find the docs, identify the docs/readthedocs.org:mdanalysis check and click on Details.

On the subsequent page, find the tiny gray link View Docs (see image below).
rtd_pr

Co-authored-by: Oliver Beckstein <[email protected]>
@MeetB7
Copy link
Contributor Author

MeetB7 commented Feb 13, 2023

Yeah the version entries now show up in the docs @orbeckst
https://mdanalysis--4022.org.readthedocs.build/en/4022/documentation_pages/analysis/rms.html#functions

@orbeckst orbeckst merged commit f5efa42 into MDAnalysis:develop Feb 13, 2023
@orbeckst
Copy link
Member

Thank you for your first contribution @MeetB7 , well done 🎉

@MeetB7
Copy link
Contributor Author

MeetB7 commented Feb 13, 2023

Thank you for your first contribution @MeetB7 , well done 🎉

Thank you for guiding me through it. I can't wait to contribute more in future.

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.

MDAnalysis.analysis.rms.rmsd docs do not show versionchanged entries
3 participants