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

Docs parser fails #22

Closed
PicoCentauri opened this issue May 12, 2021 · 0 comments · Fixed by #23
Closed

Docs parser fails #22

PicoCentauri opened this issue May 12, 2021 · 0 comments · Fixed by #23
Assignees
Labels
bug Something isn't working
Milestone

Comments

@PicoCentauri
Copy link
Collaborator

PicoCentauri commented May 12, 2021

Running mdacli with current development version of MDAnalysis the parse_docs is able to parse the docs. I pinned down the problematic entry to the universe attribute of DistanceMatrix in the diffusionmap.py. It can be easily seen by adding a print

print(klass, par_name, others_)

statement to before line L288

https://github.com/PicoCentauri/mda_cli/blob/ad619df0f7ab3473ab4c2e8789954c5c78ff0b9e/src/mdacli/cli.py#L281-L288

Most likely our regex is not able to parse the `... @joaomcteixeira do you have an idea?

Additionally it seems that MDAnalysis also got docstring entries using : and : to seperate the name and the type. I think we are not able to parse them...

@PicoCentauri PicoCentauri added the bug Something isn't working label May 12, 2021
@PicoCentauri PicoCentauri added this to the Release v1 milestone May 12, 2021
@joaomcteixeira joaomcteixeira linked a pull request May 16, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants