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

📝 Add location info to tutorial/bigger-applications.md #10552

Conversation

nilslindemann
Copy link
Contributor

@nilslindemann nilslindemann commented Oct 30, 2023

This will help the reader when reading Bigger Applications, which is about structuring a FastAPI app in multiple modules. So it uses code examples for multiple modules.

This PR adds a comment on top of each module, denoting the location of the current module (commit 1). The code highlights in the documentation are updated accordingly (commit 2).

#10554 is a translation of this.

@nilslindemann nilslindemann changed the title Add location info to docs_src/bigger applications 📝 Add location info to docs_src/bigger applications Oct 30, 2023
@tiangolo
Copy link
Owner

📝 Docs preview for commit 5f58aab at: https://0c00ab7a.fastapitiangolo.pages.dev

nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Oct 30, 2023
…ns.md`

* Full translation
* In sync with tiangolo#10552
* Google Translate used
* Manually checked
* Checked for errors using LanguageTool
@tiangolo tiangolo added the docs Documentation about how to use FastAPI label Oct 30, 2023
@tiangolo
Copy link
Owner

Good idea! 🤓

I would prefer to do it outside the file, in the code block title: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-a-title

@nilslindemann
Copy link
Contributor Author

Good Idea, I will do that.

nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Oct 31, 2023
nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Oct 31, 2023
@tiangolo
Copy link
Owner

📝 Docs preview for commit 666885c at: https://d6855de5.fastapitiangolo.pages.dev

@tiangolo
Copy link
Owner

📝 Docs preview for commit 44fcd3b at: https://b3bcaaa7.fastapitiangolo.pages.dev

@nilslindemann nilslindemann changed the title 📝 Add location info to docs_src/bigger applications 📝 Add location info to bigger-applications.md Nov 2, 2023
@nilslindemann nilslindemann changed the title 📝 Add location info to bigger-applications.md 📝 Add location info to tutorial/bigger-applications.md Nov 2, 2023
nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Nov 2, 2023
nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Nov 2, 2023
nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Nov 3, 2023
@tiangolo
Copy link
Owner

📝 Docs preview for commit b23067d at: https://3fa4a649.fastapitiangolo.pages.dev

@tiangolo
Copy link
Owner

tiangolo commented Dec 1, 2023

📝 Docs preview for commit ed53eea at: https://63d02863.fastapitiangolo.pages.dev

@tiangolo
Copy link
Owner

📝 Docs preview for commit 3703989 at: https://cc942a9c.fastapitiangolo.pages.dev

@tiangolo
Copy link
Owner

tiangolo commented Jan 11, 2024

Amazing, thank you @nilslindemann! 🚀 🙇

@tiangolo tiangolo merged commit 6bda132 into tiangolo:master Jan 11, 2024
35 checks passed
@nilslindemann nilslindemann deleted the location-info-docs_src/bigger_applications branch January 13, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation about how to use FastAPI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants