Improve Dimension.py documentation and input validation#50
Merged
Conversation
- Clarify __init__ docstring: document meta parameter contract for strict vs non-strict modes - Fix __isub__ docstring typo: 'ValeuError' -> 'ValueError' - Fix __repr__ to reflect actual strict value instead of hardcoding False - Add return type annotation and docstring to is_fixed property - Update test to match corrected repr output
- Wrap int() conversion in try/except to produce clear error messages for non-numeric strings, None, and other unconvertible types - numpy integer types (int32, int64) continue to work correctly - Maintains backward-compatible ValueError for all invalid inputs - Update docstring to document accepted types and raised exceptions
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Improve Dimension.py documentation and input validation
Summary
Improves
Dimension.pywith better documentation, corrected annotations, and hardened input validation for thesizesetter.Changes
Documentation and annotations
__init__docstring: document themetaparameter contract for strict vs non-strict modes__isub__docstring typo: "ValeuError" → "ValueError"-> boolreturn type annotation and docstring tois_fixedpropertyBug fixes
__repr__to reflect the actualstrictvalue used at construction instead of hardcodingFalseInput validation
sizesetter with try/except aroundint()conversionNone, lists, and other invalid types now produce clear error messages instead of raw Python conversion errorsnp.int32,np.int64) continue to work correctlyValueError(backward compatible)Testing
All 290 tests pass.