FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

🎨 Update inline source examples, hide `#` in annotations (from MkDocs Material) by Matthieu-LAURENT39 · Pull Request #677 · fastapi/sqlmodel · GitHub

Repository navigation

🎨 Update inline source examples, hide # in annotations (from MkDocs Material) - #677

Merged
tiangolo merged 3 commits into
fastapi:mainfrom
Matthieu-LAURENT39:prettify_docs
Oct 29, 2023
Merged

tiangolo merged 3 commits into
fastapi:mainfrom
Matthieu-LAURENT39:prettify_docs

Conversation

Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit ab08cbd at: https://10066f61.sqlmodel.pages.dev

tiangolo changed the title Hide # in annotations 🎨 Update inline source examples, hide # in annotations (from MkDocs Material) Oct 29, 2023

Copy link
Copy Markdown
Member

Thanks @Matthieu-LAURENT39! 🎉 ☕

tiangolo enabled auto-merge (squash) October 29, 2023 07:22

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit ec31941 at: https://5665f8a3.sqlmodel.pages.dev

tiangolo merged commit 9632980 into fastapi:main Oct 29, 2023
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL