Consistently use two words for force field in documentation #838
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.
Previously, force field was inconsistently rendered as either "forcefield" or "force field". With this PR, documentation, notebook examples and code comments are consistently rendered as two words. This PR also addresses a few incorrectly capitalised and spaced references to the Open Force Field Toolkit, as well as a typo I noticed while going through the docs.
It also adds the auto-generated API documentation folder,
docs/api/generated
, to the.gitignore
file. This appears to have been an oversight as it is automatically generated when the docs are built and previously could be committed.Resolves #112.
Not addressed in this PR:
ForceField
), but incorrectly in variable names (forcefield
rather than the correctforce_field
). Fixing this would constitute a breaking change to the API.PR Checklist:
Add testsUpdate docstrings/documentation, if applicable