🎨 Update inline source examples, hide # in annotations (from MkDocs Material) - #677
#677Merged
tiangolo merged 3 commits intoOct 29, 2023
fastapi:mainfastapi/sqlmodel:mainfrom
Matthieu-LAURENT39:prettify_docsMatthieu-LAURENT39/sqlmodel:prettify_docsCopy head branch name to clipboard
Merged
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677tiangolo merged 3 commits intofastapi:mainfastapi/sqlmodel:mainfrom Matthieu-LAURENT39:prettify_docsMatthieu-LAURENT39/sqlmodel:prettify_docsCopy head branch name to clipboard
# in annotations (from MkDocs Material)#677tiangolo merged 3 commits into
fastapi:mainfastapi/sqlmodel:mainfrom
Matthieu-LAURENT39:prettify_docsMatthieu-LAURENT39/sqlmodel:prettify_docsCopy head branch name to clipboard
Conversation
Contributor
|
📝 Docs preview for commit ab08cbd at: https://10066f61.sqlmodel.pages.dev |
# in annotations (from MkDocs Material)
Member
|
Thanks @Matthieu-LAURENT39! 🎉 ☕ |
tiangolo
enabled auto-merge (squash)
October 29, 2023 07:22
Contributor
|
📝 Docs preview for commit ec31941 at: https://5665f8a3.sqlmodel.pages.dev |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR hides the
#before all annotations in code blocks for the documentation.It's just a graphical change, the source code doesn't actually change
I initially also removed a space before the inline comment, changing from 2 to 1 space. It looked slightly better, but PEP8 does specify you need at least 2 spaces before an inline comment, so i played it safe and kept it at 2 spaces.
I did however keep the changes stashed, if you want.