Assorted documentation fixes (installation, FAQ, molecules.py, conf.py) #976
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
j-wags
reviewed
Jun 10, 2021
openff/toolkit/topology/molecule.py
Outdated
| @@ -5999,7 +6013,7 @@ def add_bond_charge_virtual_site(self, atoms, distance, **kwargs): | |||
|
|
|||
| Create a bond charge-type virtual site, in which the location of the | |||
| charge is specified by the position of two atoms. This supports | |||
| placement of a virtual site S along a vector between two specified | |||
| placement of a virtual site $S$ along a vector between two specified | |||
There was a problem hiding this comment.
This $S$ renders verbatim as written
j-wags
approved these changes
Jun 10, 2021
There was a problem hiding this comment.
I've spot checked a bit and this looks great. Thanks @Yoshanuikabundi. I just commented on one place where the math doesn't seem to be rendering properly, other than that it should be good to go!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have rendering errors littered throughout our documentation. This PR is a start at going through the docs one at a time until we've got them all.
Highlights in this PR:
All the questions in the FAQ are now questions
The list of methods in the API docs now only renders once per class. Previously, it rendered once before the
__init__()docs and repeated itself after.installation.rstis nowinstallation.mdconf.py has had black run on it
Tag issue being addressed
Add tests
Update docstrings/documentation, if applicable
Lint codebase
Update changelog