Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from Oct 29, 2023

Conversation

Matthieu-LAURENT39
Copy link
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.

@github-actions
Copy link

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

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

Thanks @Matthieu-LAURENT39! 🎉 ☕

@tiangolo tiangolo enabled auto-merge (squash) October 29, 2023 07:22
@github-actions
Copy link

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

@tiangolo tiangolo merged commit 9632980 into tiangolo:main Oct 29, 2023
11 checks passed
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.

None yet

2 participants