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

Make naming consistent for precondtions and postconditions. #433

Merged
merged 1 commit into from
Jan 21, 2021

Conversation

bdice
Copy link
Member

@bdice bdice commented Jan 20, 2021

Description

Resolves #216.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality.

Checklist:

If necessary:

  • I have updated the API documentation as part of the package doc-strings.
  • I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
  • I have updated the changelog.

@bdice bdice requested review from a team as code owners January 20, 2021 19:16
@bdice bdice requested review from atravitz and jennyfothergill and removed request for a team January 20, 2021 19:16
@codecov
Copy link

codecov bot commented Jan 20, 2021

Codecov Report

Merging #433 (a1a5f65) into master (03fe709) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #433   +/-   ##
=======================================
  Coverage   70.44%   70.44%           
=======================================
  Files          29       29           
  Lines        2994     2994           
  Branches      553      553           
=======================================
  Hits         2109     2109           
  Misses        737      737           
  Partials      148      148           
Impacted Files Coverage Δ
flow/project.py 73.64% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 03fe709...a1a5f65. Read the comment docs.

@bdice bdice enabled auto-merge (squash) January 21, 2021 01:39
@bdice bdice disabled auto-merge January 21, 2021 01:39
@bdice bdice merged commit fe5139b into master Jan 21, 2021
@bdice bdice deleted the doc/preconditions-postconditions-naming branch January 21, 2021 01:39
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.

Consistently refer to pre/post-conditions in docstrings
1 participant