DM-34141: clarify DimensionPacker documentation #913
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
DimensionPacker's handling of fixed dimensions is not Liskov-compliant, so it's hard to specify the behavior the user will see when dealing with a DimensionPacker of unknown type.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #913 +/- ##
=======================================
Coverage 87.31% 87.31%
=======================================
Files 286 286
Lines 37168 37168
Branches 7833 7833
=======================================
Hits 32452 32452
Misses 3519 3519
Partials 1197 1197 ☔ View full report in Codecov by Sentry. |
TallJimbo
approved these changes
Nov 30, 2023
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 PR edits the documentation of
DimensionPackerand itspackmethod to clarify what behavior is and isn't guaranteed for allDimensionPackerclasses.Checklist
doc/changes