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.

Sign up for GitHub

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

Jump to bottom

[docs] MDAnalysis.analysis.polymer.PersistenceLength does not document run() method #4793

Open
orbeckst opened this issue Nov 19, 2024 · 4 comments · May be fixed by #4864
Open

[docs] MDAnalysis.analysis.polymer.PersistenceLength does not document run() method #4793

orbeckst opened this issue Nov 19, 2024 · 4 comments · May be fixed by #4864
Labels
Component-Docs Difficulty-easy help wanted outreachy-task Starter tasks for the Outreachy program

Comments

@orbeckst
Copy link
Member

Expected behavior

Docs contain all information needed to use analysis class, in particular the run() method. Users should not need to know to look it up under AnalysisBase.

Actual behavior

MDAnalysis.analysis.polymer.PersistenceLength does not document run() method

Code to reproduce the behavior

See https://docs.mdanalysis.org/stable/documentation_pages/analysis/polymer.html#MDAnalysis.analysis.polymer.PersistenceLength

Current version of MDAnalysis

  • Which version are you using? in 2.8.0 docs
@orbeckst
Copy link
Member Author

Missing docs presumably lead to a question on how PersistenceLength works. https://discord.com/channels/807348386012987462/807348386012987465/1308376414034333716

@Rishabh044
Copy link

So basically we need to change only docs and link it to AnalysisBase class?

@orbeckst
Copy link
Member Author

orbeckst commented Dec 1, 2024 •
edited
Loading

Probably just add the right :members: or :inherited-members: option to the docs. See https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html for background.

If you create a PR, make sure that you look at the ReadTheDocs version of the docs that is build from the PR. You find it as one of the Checks named docs/readthedocs.org:mdanalysis — Read the Docs build succeeded! and then follow the link under Details. Then look if your changes fixed the docs and if yes, add a comment on your PR that you yourself confirmed that you fixed the issue.

@tanishy7777 tanishy7777 linked a pull request Dec 24, 2024 that will close this issue
Open
5 tasks
@tanishy7777
Copy link
Contributor

I have added the PR for this please let me know if it requires any changes @orbeckst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Component-Docs Difficulty-easy help wanted outreachy-task Starter tasks for the Outreachy program
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DocFix: Added the documentation for run() method in polymer.rst tanishy7777/mdanalysis
3 participants
@orbeckst @Rishabh044 @tanishy7777