Fix type annotations in examples #1248
Merged
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
Codecov Report
@@ Coverage Diff @@
## master #1248 +/- ##
===========================================
- Coverage 100.00% 99.89% -0.11%
===========================================
Files 21 21
Lines 3666 3689 +23
Branches 718 726 +8
===========================================
+ Hits 3666 3685 +19
- Misses 0 2 +2
- Partials 0 2 +2
Continue to review full report at Codecov.
|
explicit assignment for an optional field Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>
explicit assignment for an optional field Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>
|
thanks so much. |
RajatRajdeep
pushed a commit
to RajatRajdeep/pydantic
that referenced
this pull request
May 14, 2024
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.
Change Summary
As discussed in #1072, the very first example in the docs does not feature valid mypy annotations (nullable datetime is not designated as optional). I suggest fixing this to follow mypy annotations fully.
There was some discussion about adding more narrative to these docs - I have not done so, because I can't quite figure out what to say exactly - if the
Optionaltype hint should be elaborated on or something? I'd welcome suggestions regarding this.Related issue number
#1072
Checklist
[ ] Unit tests for the changes exist[ ] Tests pass on CI and coverage remains at 100%changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)