fix: relase ReviewUser name to accept None, add docs #232
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
lwasser
commented
Nov 21, 2024
| @@ -228,7 +228,7 @@ def clean_date(cls, a_date: Optional[str]) -> str: | |||
| class ReviewUser(BaseModel): | |||
| """Minimal model of a github user, used in several places in review parsing""" | |||
|
|
|||
| name: str | |||
| name: str | None | |||
There was a problem hiding this comment.
This is the only real change. it's ok for this to be None.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #232 +/- ##
=======================================
Coverage 73.99% 73.99%
=======================================
Files 10 10
Lines 669 669
Branches 82 82
=======================================
Hits 495 495
Misses 166 166
Partials 8 8 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
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 also loosely addresses #227
In this case Name was being added to the build only because Name was in the actual review issue. We really can't account for every where thing people add to a complex issue template so i think just fixing the review is best in this case.
But also, I relaxed our ReviewUser model to allow for a None for Name as sometimes that might be missing and we do want to look it up in our contribs file if that is the case.