Skip to content

📝 Fix and Improve English Documentation#14048

Merged
tiangolo merged 12 commits intofastapi:masterfrom
nilslindemann:fixes-in-english-docs
Sep 20, 2025
Merged

📝 Fix and Improve English Documentation#14048
tiangolo merged 12 commits intofastapi:masterfrom
nilslindemann:fixes-in-english-docs

Conversation

@nilslindemann
Copy link
Contributor

@nilslindemann nilslindemann commented Sep 5, 2025

These are fixes I found / changes I made when doing #14015, including improvements by Yurii.

The LLM prompt looks for this format when it is a full phrase for an abbreviation followed by some other information. It will then translate the title attribute using the scheme:

`{full phrase}: {information}` --> `{full phrase} – {translation of full phrase}: {translation of information}`

Using a comma instead of the colon matches title attributes which fit not into that category, which confuses the LLM.
I guess this was overlooked in a removal.
We should use neutral single or double quotes ('...' or "...") when translation is desired and otherwise backticks (`...`).
It alkso links there in `tutorial/request-files.md`.
@nilslindemann nilslindemann marked this pull request as draft September 5, 2025 13:20
@github-actions github-actions bot added the docs Documentation about how to use FastAPI label Sep 5, 2025
@github-actions

This comment was marked as outdated.

nilslindemann added a commit to nilslindemann/fastapi that referenced this pull request Sep 6, 2025
These changes are now handled in fixes-in-english-docs (fastapi#14048).
nilslindemann and others added 2 commits September 6, 2025 15:00
... which I forgot/overlooked

Co-Authored-By: Motov Yurii <[email protected]>
... found while retranslating the German docs. See also earlier commit 506f773
@nilslindemann nilslindemann marked this pull request as ready for review September 6, 2025 13:03
@github-actions

This comment was marked as outdated.

@nilslindemann nilslindemann changed the title Fixes in English docs 🔨 (Mostly) fixes in English docs Sep 6, 2025
@YuriiMotov YuriiMotov changed the title 🔨 (Mostly) fixes in English docs 📝 Fix and Improve English Documentation Sep 8, 2025
Copy link
Member

@YuriiMotov YuriiMotov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@github-actions

This comment was marked as outdated.

@github-actions
Copy link
Contributor

📝 Docs preview for commit 28c15d7 at: https://e8049075.fastapitiangolo.pages.dev

Modified Pages

Copy link
Member

@tiangolo tiangolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Niceee! This is great, thank you! 🔍 🚀

@tiangolo tiangolo merged commit 7095a11 into fastapi:master Sep 20, 2025
53 checks passed
@nilslindemann
Copy link
Contributor Author

Ditto, thanks!

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.

3 participants