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

Fix incorrect docstring, resolve #506. #563

Merged
merged 2 commits into from
Jun 3, 2021
Merged

Conversation

bdice
Copy link
Member

@bdice bdice commented Jun 3, 2021

Description

See #506 for issue description. This alters a docstring whose described behavior doesn't match the implementation.

Motivation and Context

Resolves #506.

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 and added all related issue and pull request numbers for future reference (if applicable). See example below.

@bdice bdice requested review from a team as code owners June 3, 2021 03:19
@bdice bdice requested review from csadorf and pepak13 and removed request for a team June 3, 2021 03:19
@bdice bdice requested review from cbkerr and removed request for csadorf and pepak13 June 3, 2021 03:20
@bdice bdice self-assigned this Jun 3, 2021
@bdice bdice added bug Something isn't working documentation Writing or editing documentation labels Jun 3, 2021
@bdice bdice added this to the 1.7.0 milestone Jun 3, 2021
@codecov
Copy link

codecov bot commented Jun 3, 2021

Codecov Report

Merging #563 (722be2f) into master (6a3c2be) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #563   +/-   ##
=======================================
  Coverage   78.27%   78.27%           
=======================================
  Files          65       65           
  Lines        7069     7069           
  Branches     1311     1311           
=======================================
  Hits         5533     5533           
  Misses       1231     1231           
  Partials      305      305           
Impacted Files Coverage Δ
signac/contrib/job.py 90.55% <ø> (ø)
signac/contrib/project.py 85.29% <ø> (ø)

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 6a3c2be...722be2f. Read the comment docs.

Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

Thx for fixing!

Copy link
Member

@cbkerr cbkerr left a comment

Choose a reason for hiding this comment

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

Thanks 🥺

@bdice bdice merged commit ec9103e into master Jun 3, 2021
@bdice bdice deleted the fix/overwrite-docstring branch June 3, 2021 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Writing or editing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect docstring in Job.update_statepoint
3 participants