Skip to content

clean API pages batch 1to4 #4999

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

namiroues
Copy link
Contributor

@namiroues namiroues commented Mar 29, 2025

Fixes #4998

The edits in this PR only apply to non-autogenerated API documentation pages. I did not modify any auto-generated API reference files (e.g., those populated via automodule, autoclass, autofunction, etc.).

All changes were made to manually written .rst files that provide curated narrative content or structured overviews (e.g., analysis.rst, topology.rst, parallelization.rst). These are not overwritten by Sphinx during builds and are safe to edit directly.

I certify that I can submit this code contribution as described in the Developer Certificate of Origin, under the MDAnalysis LICENSE.


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

@namiroues namiroues added the SDG23 work on Small Development Grant 2023 label Mar 29, 2025
@namiroues namiroues moved this from Todo to In Progress in Streamlining Documentation (SDG23) Mar 29, 2025
Copy link

codecov bot commented Mar 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.41%. Comparing base (35d9d2e) to head (cff9772).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4999      +/-   ##
===========================================
- Coverage    93.42%   93.41%   -0.02%     
===========================================
  Files          177      189      +12     
  Lines        21859    22931    +1072     
  Branches      3078     3079       +1     
===========================================
+ Hits         20422    21421     +999     
- Misses         986     1059      +73     
  Partials       451      451              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@orbeckst
Copy link
Member

I probably won't get to reviewing for a while because there's too much GSOC to do, sorry. Please find another reviewer.

@namiroues namiroues requested a review from RMeli March 31, 2025 06:34
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.

LGTM!

Only a few very minor comments and nitpicks. (I'm not a native speaker, so please disregard as you see fit.)

@namiroues
Copy link
Contributor Author

Thanks @RMeli for the comments. I made the changes.

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

@orbeckst
Copy link
Member

@micaela-matta can you please shepherd the PR to completion?

@orbeckst
Copy link
Member

orbeckst commented Apr 14, 2025

@namiroues when someone approves your PR, you don't need to ask for their review again. They trusted you you'd do the right thing and they might not have time to just say "yes" again — people often don't have 5 minutes to open a PR and look at it for a LGTM. EDIT: It's also bad for getting your PR merged because the re-request deletes their previous approval and then your perfectly fine PR shows up as "no approvals". I added my approval a few days ago, just so that there's a "ok" on it because @RMeli had already signed off. We probably could have merged this PR 2 weeks ago.

I'll now leave the actual finalizing/merging to @micaela-matta .

EDIT: I was wrong, the approval is recorded and not deleted... it's just confusing when you look at the reviewer list and nobody has green tickmark.

@RMeli
Copy link
Member

RMeli commented Apr 14, 2025

Sorry, I missed this re-review request!

I agree with @orbeckst that it is not necessary to re-request a review on approval (unless you completely change the PR).

@RMeli
Copy link
Member

RMeli commented Apr 14, 2025

EDIT: I was wrong, the approval is recorded and not deleted... it's just confusing when you look at the reviewer list and nobody has green tickmark.

I don't think you were wrong. The approval is indeed recorded in the PR history, but it doesn't show up in the top level (PR reviewers, PR list, etc.) and I don't think it counts as a required review to allow merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component-Docs SDG23 work on Small Development Grant 2023
Projects
Development

Successfully merging this pull request may close these issues.

Clean API pages - modules 1, 2, 3, 4
4 participants