Format docs for import #48
Merged
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 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 #48 +/- ##
=======================================
Coverage 95.37% 95.37%
=======================================
Files 5 5
Lines 303 303
Branches 78 78
=======================================
Hits 289 289
Misses 12 12
Partials 2 2 ☔ View full report in Codecov by Sentry. |
This was referenced May 4, 2023
hramezani
reviewed
May 5, 2023
| @@ -1,3 +1,4 @@ | |||
|
|
|||
There was a problem hiding this comment.
Isn't it better to use # Pydantic Settings as you suggested in PR body?
There was a problem hiding this comment.
I think we'll expand these docs in a future PR and can address headings at that time.
hramezani
approved these changes
May 5, 2023
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.
Formats the index.md page so it can be imported into pydantic docs using https://github.com/fire1ce/mkdocs-embed-external-markdown.
Current the plugin assumes the first line is a heading and strips it. This adds a blank line so no stripping occurs. Same workaround could be handled by adding a
# Pydantic Settingsheading, which might be something to do in the future.