Adopt pydantic-settings docs for Pydantic V2 #18
Conversation
hramezani
force-pushed
the
docs_integration
branch
from
2b0ad37
to
e6e28da
Compare
Codecov ReportPatch and project coverage have no change.
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## main #18 +/- ##
=======================================
Coverage 96.00% 96.00%
=======================================
Files 5 5
Lines 275 275
Branches 67 67
=======================================
Hits 264 264
Misses 10 10
Partials 1 1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
please move these inline, into the markdown files.
There was a problem hiding this comment.
I've converted these examples to be compatible with V2 and added them here in examples directory to be compatible with Pydantic documents.
Also, I've added them directly in index.md as well.
When we decided about the docs repo and the way that we want to handle them we can we can use them directly.
There was a problem hiding this comment.
README.md
Outdated
| @@ -5,3 +5,5 @@ | |||
| [](https://github.com/pydantic/pydantic-settings/blob/main/LICENSE) | |||
|
|
|||
| **Work in Progress**, see https://github.com/pydantic/pydantic/pull/4492 | |||
|
|
|||
| {!docs/index.md!} | |||
There was a problem hiding this comment.
I don't think we should include this, since it won't work in github.
There was a problem hiding this comment.
My plan was to make new docs available for the users because the old docs are outdated and we need to somehow share the new docs with the user.
Removed!
docs/index.md
Outdated
| """ | ||
| ``` | ||
|
|
||
| <!--- {!.tmp_examples/settings_main.md!} ---> |
There was a problem hiding this comment.
As you can see the example code is injected directly here in the md file and this line is commented. Whenever we decided about the docs, we can uncomment this line and remove the above example code
hramezani
force-pushed
the
docs_integration
branch
3 times, most recently
from
883caf8
to
6a29a7d
Compare
docs/index.md
Outdated
|
|
||
| model_config = ConfigDict(case_sensitive=True) | ||
| ``` | ||
| <!--- {!.tmp_examples/settings_case_sensitive.md!} ---> |
There was a problem hiding this comment.
i think we should remove these.
There was a problem hiding this comment.
I guess we can remove all these files now that they're copied into index.md
hramezani
force-pushed
the
docs_integration
branch
from
6a29a7d
to
86c9e02
Compare
|
LGTM, please enable auto-merge if you're happy with this. |
|
@samuelcolvin I just create an issue for |
It's based on the change on #17 to make pydantic-settings compatible with Pydantic V2.
All the docs and examples changed to be compatible