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

Deprecate state point backup files. #579

Merged
merged 4 commits into from
Aug 9, 2021

Conversation

bdice
Copy link
Member

@bdice bdice commented Jul 26, 2021

Description

Following conversation on #197, I am creating this PR to deprecate methods for state point backup files.

#197 (comment)

Once this PR is merged into master, we should merge master into next. Then we can tackle changes from this PR (removing read_statepoints, write_statepoints, dump_statepoints and some corresponding changes in behavior) in a new PR to next.

Motivation and Context

Reducing the API to core features for signac 2.0 in alignment with discussion on #197.

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 July 26, 2021 05:06
@bdice bdice requested review from vyasr and jennyfothergill and removed request for a team July 26, 2021 05:06
@bdice bdice requested review from atravitz and removed request for jennyfothergill July 26, 2021 05:07
@codecov
Copy link

codecov bot commented Jul 26, 2021

Codecov Report

Merging #579 (f2f2975) into master (378a6be) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #579   +/-   ##
=======================================
  Coverage   78.26%   78.27%           
=======================================
  Files          65       65           
  Lines        7066     7069    +3     
  Branches     1310     1310           
=======================================
+ Hits         5530     5533    +3     
  Misses       1231     1231           
  Partials      305      305           
Impacted Files Coverage Δ
signac/contrib/project.py 85.29% <100.00%> (+0.05%) ⬆️

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 378a6be...f2f2975. Read the comment docs.

@bdice bdice added this to the v2.0.0 milestone Jul 26, 2021
@bdice bdice self-assigned this Jul 27, 2021
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

LGTM

@bdice bdice merged commit 70d480e into master Aug 9, 2021
@bdice bdice deleted the feature/deprecate-state-point-backups branch August 9, 2021 16:16
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.

2 participants