Add deprecation notice for Resource.flush_to_disk #568
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
whyitfor
force-pushed
the
maintenance/flush_to_disk
branch
from
aef6b9a to
d735887
Compare
rbs-jacob
requested changes
Jan 13, 2025
Comment on lines
+67
to
+69
| ### Deprecated | ||
| - `Resource.flush_to_disk` deprecated in favor of `Resource.flush_data_to_disk`. ([#373](https://github.com/redballoonsecurity/ofrak/pull/373), [#567](https://github.com/redballoonsecurity/ofrak/pull/568)) | ||
|
|
There was a problem hiding this comment.
Should we change line 51 of this file if we're writing about the deprecation here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One sentence summary of this PR (This should go in the CHANGELOG!)
Deprecate
Resource.flush_data_to_diskLink to Related Issue(s)
Closes #567.
Please describe the changes in your request.
#373 renamed
Resource.flush_to_disktoResource.flush_data_to_diskto indicate that it only flushes data, not attributes. This PR preserves this API with a DeprecationWarning in preparation for a 3.3.* release.Anyone you think should look at this, specifically?
@rbs-jacob