Add note about nested model should inherit BaseModel #165
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
hramezani
force-pushed
the
nested-model-doc
branch
from
411dda6
to
f7e810d
Compare
Kludex
approved these changes
Sep 11, 2023
docs/index.md
Outdated
Comment on lines
279
to
281
| 1. Sub model has to inherit from `pydantic.BaseModel`, Otherwise you may get unexpected results. | ||
|
|
||
| 2. Sub model has to inherit from `pydantic.BaseModel`, Otherwise you may get unexpected results. |
There was a problem hiding this comment.
Can we point out some reference as what this means? 🤔
There was a problem hiding this comment.
I've added more detail to it. If you think it is not enough, I have to add a separate section for it.
what do you think @Kludex?
hramezani
force-pushed
the
nested-model-doc
branch
from
f7e810d
to
fcc09db
Compare
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #165 +/- ##
=======================================
Coverage 97.45% 97.45%
=======================================
Files 5 5
Lines 314 314
Branches 69 69
=======================================
Hits 306 306
Misses 6 6
Partials 2 2 ☔ View full report in Codecov by Sentry. |
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.
Related to #159