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

Cleaning up analysis.__ini__ and hole2 docs #2786

Closed
IAlibay opened this issue Jun 23, 2020 · 4 comments
Closed

Cleaning up analysis.__ini__ and hole2 docs #2786

IAlibay opened this issue Jun 23, 2020 · 4 comments

Comments

@IAlibay
Copy link
Member

IAlibay commented Jun 23, 2020

As discussed in this thread: #2778 (comment) the analysis.__init__ docstring doesn't seem to be used anywhere and is somewhat superseded by analysis_modules.rst, thoughts on what to do with this text?

Furthermore, linked to that same PR, it seems that there is no page specifically for analysis.hole2, with the docstring instead being in analysis.hole2.hole. Should we be moving the core of the hole2.hole docstring to hole2.__init__ instead?

@orbeckst
Copy link
Member

I often use help(module) or module? and then it's nice if a short, comprehensible doc string appears. If we don't use the doc string in the generated docs then I would suggest to cut down analysis.__init__ to something brief (and possibly include a link to the online docs).

All the classes and functions that are important for a user show up under analysis.hole2 so I'd expect the docs to reflect it broadly. I.e., have the general docs appear for hole2 there, so I would move the general docs from hole2.hole to hole2.__init__ and have the classes/functions remain in hole2.hole. I have lately played around with sphinx.autosummary and one could put a summary of classes into hole2.

@manishsaini6421
Copy link
Contributor

@orbeckst Sir , i have fixed this issue. can you review it please.

@IAlibay
Copy link
Member Author

IAlibay commented Mar 30, 2022

@manishsaini6421 both @lilyminium and I have commented on #3579, those comments will need to be addressed before we consider reviewing.

manishsaini6421 added a commit to manishsaini6421/mdanalysis that referenced this issue Apr 3, 2022
lilyminium pushed a commit that referenced this issue Apr 12, 2022
Part of #2786
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
@lilyminium
Copy link
Member

Closed by #3579

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants