refactor: remove default in delete_existing_files() #64
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
msarahan
approved these changes
Jan 2, 2024
ajschmidt8
approved these changes
Jan 3, 2024
|
🎉 This PR is included in version 1.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
delete_existing_files()is used to clean up previous work done bydependency-file-generator.This PR proposes removing the default path that function uses when looking for files to delete.
How is this safe?
That function is only used in one place, and a value is explicitly passed in that place.
dependency-file-generator/src/rapids_dependency_file_generator/cli.py
Line 103 in 36a4061
Benefits of this change
Makes the flow of configuration stricter, reduces the risk of "forgot to pass through this configuration and silently fell back to a default" types of bugs.
Notes for Reviewers
This isn't in response to any particular issue.
I'm just reading through the library to understand it better, and noticed this.