Ignore documentation string mismatch in dimension validation #40
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #40 +/- ##
==========================================
+ Coverage 55.66% 58.68% +3.01%
==========================================
Files 38 38
Lines 1315 1428 +113
Branches 281 302 +21
==========================================
+ Hits 732 838 +106
- Misses 546 549 +3
- Partials 37 41 +4 ☔ View full report in Codecov by Sentry. |
Users are having trouble running universe v5 -> v6 migrations because of the error generated for mismatched dimension universes. There is a known mismatch of documentation strings in some older repositories that is spuriously throwing an error. Add a special case to ignore this known mismatch so that users don't have to add special options to complete the migration.
In the new version of uv, they dropped support for the VIRTUAL_ENV environment variable.
dhirving
force-pushed
the
tickets/DM-44546
branch
from
e8eba41 to
0da4428
Compare
andy-slac
reviewed
May 24, 2024
Comment on lines
261
to
274
| def _is_expected_diff_line(line: str) -> bool: | ||
| # ndiff prefix for matching lines and "hint" lines. | ||
| if line.startswith(" ") or line.startswith("? "): | ||
| return True | ||
|
|
||
| # Lines containing only docstring changes. | ||
| if re.match(r'^[-+]\s+"doc":', line): | ||
| return True | ||
|
|
||
| # Empty line. | ||
| if line.strip() == "": | ||
| return True | ||
|
|
||
| return False |
There was a problem hiding this comment.
Feels a bit fragile. Would it be better to just ignore doc strings when doing diff (maybe optionally)? You could load JSON from string into dict, drop all doc keys recursively and compare the result.
andy-slac
approved these changes
May 24, 2024
Instead of trying to filter out doc strings after running the diff, adjust the input to the diff to get the same effect. This is a little less fragile.
dhirving
force-pushed
the
tickets/DM-44546
branch
from
70fc9cc to
fe805b7
Compare
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.
Users are having trouble running universe v5 -> v6 migrations because of the error generated for mismatched dimension universes. There is a known mismatch of documentation strings in some older repositories that is spuriously throwing an error.
Add a special case to ignore this known mismatch so that users don't have to add special options to complete the migration.
Checklist