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

Inconsistent with force field as 2 words #112

Closed
bannanc opened this issue May 10, 2018 · 1 comment · Fixed by #838
Closed

Inconsistent with force field as 2 words #112

bannanc opened this issue May 10, 2018 · 1 comment · Fixed by #838

Comments

@bannanc
Copy link
Collaborator

bannanc commented May 10, 2018

The READMEs in this repository are still inconsistent about if force field is one word or two. The Mobley group has been using "force field" and I believe OpenFF agreed on this as well via Slack, but we should make sure we're consistent in our documentation and especially when we write our own name!

@j-wags
Copy link
Member

j-wags commented Feb 12, 2021

Some guidelines:

  • We should make sure the spacing is "Force field" anywhere in
    • user-facing text (markdown and reStructuredText),
    • jupyter notebook markdown blocks
    • python docstrings
    • mentions of the organization name ("Open Force Field")
  • We should use the case-sensitive ForceField class name in direct references to the python class

This Issue can be closed when:

  • A PR is merged where the git repo has been reviewed and instances of incorrect usage are fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants