segmentation.py: code quality improvements #86
Closed
Conversation
This file contains hidden or 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
Summary: This diff removes internal references to wikis, documentation, code, etc from utils.py and its tests. Differential Revision: D90120757
Summary: Code quality improvements for segmentation.py and its tests following Google Python style guide and Python Enhancement Proposals (PEPs): **Logging format (Google style guide 3.10.1):** - Changed `logger.debug()` from f-string to %-placeholder format - Logging functions should use pattern-strings with %-placeholders as their first argument, not f-strings, because: - Logging implementations can collect unexpanded pattern-strings as queryable fields - Prevents spending time rendering messages that no logger is configured to output **Docstring formatting (PEP 257 / PEP 8 - 80 character limit):** - Reformatted `get_segment_masks()` docstring to comply with 80-character line limit - Split long summary line into concise summary + detailed description - Wrapped all parameter descriptions to fit within 80 characters - Fixed Notes section formatting to use proper indentation (was using NumPy-style `------` separator) **Test naming fixes (PEP 8 - descriptive naming):** - Fixed typo "nana" → "NaN" in two test function comments (lines 35, 106) - Fixed typo "infequent" → "infrequent" in function name: `test_that_collapse_infrequent_values_collapses_correctly_for_happy_path` - Fixed typo "numer" → "number" in two function names: - `test_that_collapse_numeric_values_returns_correct_number_of_values` - `test_that_collapse_numeric_values_returns_correct_number_of_values_with_max_values_1` Reviewed By: flinder Differential Revision: D90172889
flinder
requested review from
Lorenzo-Perini,
TaXxER and
danielha1
as code owners
meta-cla
bot
added
the
CLA Signed
|
This pull request has been merged in 7a18df8. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary:
Code quality improvements for segmentation.py and its tests following Google Python style guide and Python Enhancement Proposals (PEPs):
Logging format (Google style guide 3.10.1):
logger.debug()from f-string to %-placeholder formatDocstring formatting (PEP 257 / PEP 8 - 80 character limit):
get_segment_masks()docstring to comply with 80-character line limit------separator)Test naming fixes (PEP 8 - descriptive naming):
test_that_collapse_infrequent_values_collapses_correctly_for_happy_pathtest_that_collapse_numeric_values_returns_correct_number_of_valuestest_that_collapse_numeric_values_returns_correct_number_of_values_with_max_values_1Reviewed By: flinder
Differential Revision: D90172889