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

Consistently use two words for force field in documentation #838

Merged
merged 5 commits into from Feb 18, 2021

Conversation

Yoshanuikabundi
Copy link
Collaborator

@Yoshanuikabundi Yoshanuikabundi commented Feb 16, 2021

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:

  • Force field is typically rendered correctly according to PEP8 naming rules for class names (ForceField), but incorrectly in variable names (forcefield rather than the correct force_field). Fixing this would constitute a breaking change to the API.
  • File names are not changed to preserve URLs
  • No regression tests are added. If we later add lints for documentation, one of them can be a spellchecker and we can make sure forcefield is not in the dictionary. Short of that, a regression test would have to be familiar with every syntax in the repository so that it knows how to ignore URLs, filenames, code examples, actual code etc.

PR Checklist:

@codecov
Copy link

codecov bot commented Feb 16, 2021

Codecov Report

Merging #838 (55b7f96) into master (5cbfaf2) will decrease coverage by 0.27%.
The diff coverage is n/a.

Copy link
Member

@j-wags j-wags left a comment

Choose a reason for hiding this comment

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

This looks great! A few suggested changes based on markdown/rendering weirdness. But otherwise this is perfect.

Feel free to merge once you've committed the suggested changes, or if you'd like we can merge at the beginning of our next call.

docs/typing.rst Outdated Show resolved Hide resolved
docs/typing.rst Outdated Show resolved Hide resolved
openff/toolkit/utils/toolkits.py Outdated Show resolved Hide resolved
openff/toolkit/utils/toolkits.py Outdated Show resolved Hide resolved
@Yoshanuikabundi Yoshanuikabundi merged commit adde241 into master Feb 18, 2021
@Yoshanuikabundi Yoshanuikabundi deleted the two-word-ff branch March 12, 2021 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent with force field as 2 words
2 participants