-
Notifications
You must be signed in to change notification settings - Fork 652
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
Add docs for libmdanalysis #3922
Conversation
Codecov ReportBase: 94.36% // Head: 94.36% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## develop #3922 +/- ##
========================================
Coverage 94.36% 94.36%
========================================
Files 194 194
Lines 25109 25109
Branches 3398 3398
========================================
Hits 23694 23694
Misses 1366 1366
Partials 49 49 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you show a simple example for how the header is imported and how something in it is used (e.g., instantiate a Timestep)?
Is there a way to generate a list of publicly defined objects? If we cannot generate such a list automatically, could you mention the most important ones (i.e., Timestep at the moment as far as I can tell) and then say something along the lines "for details consult the source file" (and perhaps link to MDAnalysis/lib/libmdanalysis/init.pxd.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, just making two changes
Fixes #3921
Changes made in this Pull Request:
PR Checklist