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 refer to pre/post-conditions in docstrings #216

Closed
vyasr opened this issue Jan 20, 2020 · 1 comment · Fixed by #433
Closed

Consistently refer to pre/post-conditions in docstrings #216

vyasr opened this issue Jan 20, 2020 · 1 comment · Fixed by #433
Labels
documentation Writing or editing documentation good first issue Good for newcomers refactor Code refactoring

Comments

@vyasr
Copy link
Contributor

vyasr commented Jan 20, 2020

This is a very minor issue, but we are currently very inconsistent with our usage of pre-condition vs pre condition. However, precondition (without a space or hyphen) is an accepted word, as is postcondition, so we should replace these consistently in the docs.

@bdice bdice added the documentation Writing or editing documentation label Feb 27, 2020
@bdice
Copy link
Member

bdice commented Dec 10, 2020

The docstrings side of this issue is fixed by the combination of #387, #389, and #392. However, internal names like _collect_pre_conditions and _OPERATION_PRE_CONDITIONS still exist. Those should be replaced with names like _collect_preconditions and _OPERATION_PRECONDITIONS. I think these changes would be confined to flow/project.py and tests/test_project.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Writing or editing documentation good first issue Good for newcomers refactor Code refactoring
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants