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

fix: rdkit.Chem.rdDistGeom.EmbedMultipleConfs docstring indentation #5404

Merged
merged 1 commit into from
Jul 6, 2022

Conversation

jvansan
Copy link
Contributor

@jvansan jvansan commented Jul 5, 2022

Reference Issue

N/A - simple doc fix

What does this implement/fix? Explain your changes.

The indentation of the parameters for EmbedMultipleConfs @ https://www.rdkit.org/docs/source/rdkit.Chem.rdDistGeom.html had an extra level of indentation. I believe I have corrected this.

Any other comments?

I'm not 100% confident on the translation from C++ -> Python docstring here and don't know how to confirm my docstring. I also could not find instructions for building docs. I suspect there should not be any problems from such a minor change.

Copy link
Member

@greglandrum greglandrum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@greglandrum
Copy link
Member

I'm not 100% confident on the translation from C++ -> Python docstring here and don't know how to confirm my docstring. I also could not find instructions for building docs. I suspect there should not be any problems from such a minor change.

The "easiest" way to see the effects of changes in these docstrings is to do a full build, import the changed package into python, and look at the resulting docstrings. This, of course, isn't at all easy unless you're already used to building the C++ code. But, you're right, changing the docstrings shouldn't break anything. :-)

Thanks for the contribution!

@greglandrum greglandrum merged commit 73d0d82 into rdkit:master Jul 6, 2022
@greglandrum greglandrum added documentation Cleanup Code cleanup and refactoring labels Jul 6, 2022
@greglandrum greglandrum added this to the 2022_03_5 milestone Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cleanup Code cleanup and refactoring documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants