Change terminology from "freezing" to "pausing" #680
Merged
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
Signed-off-by: Sergey Vasilyev <[email protected]>
This covers: * Documentation and examples. * Code comments and docstrings. * Variable names. * Log messages. * Tests. But not: * `kopf freeze` CLI — that would require the public interface change. As the primary goal, the variables are now named after their main purpose and meaning (operator_paused, conflicts_found) instead of their type or role (freeze_checker, freeze_toggle). This makes code more readable semantically (as if reading English). And also enabled adding more checkers & toggle with different roles (e.g. for cache pre-population). As a secondary goal, it is now called "pausing", as there are already too many things named after "freezing": `freezegun`, `frozen_time`, task freezing, API requests freezing (for auth), frozen dataclasses, throttling freezes on errors, etc. The word is overloaded with meanings, while "pausing" is nearly unused. **IMPORTANT:** The code and logic are exactly the same! Nothing is changed, just renamed. The public interface is not affected, only the internal things are. Signed-off-by: Sergey Vasilyev <[email protected]>
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.
This covers:
But not:
kopf freezeCLI — that would require the public interface change.As the primary goal, the variables are now named after their main purpose and meaning (operator_paused, conflicts_found) instead of their type or role (freeze_checker, freeze_toggle). This makes code more readable semantically (as if reading English). And also enabled adding more checkers & toggle with different roles (e.g. for cache pre-population).
As a secondary goal, it is now called "pausing", as there are already too many things named after "freezing":
freezegun,frozen_time, task freezing, API requests freezing (for auth), frozen dataclasses, throttling freezes on errors, etc. The word is overloaded with meanings, while "pausing" is nearly unused.This is also related to #675, where the daemons were temporarily stopped because the operator is "pausing", not "freezing" (that was done intentionally, with this renaming in mind).
IMPORTANT: The code and logic are exactly the same! Nothing is changed, just renamed. The public interface is not affected, only the internal things are.