📝 Fix typos and standardize spelling and terminology in tutorials #13995
Conversation
There was a problem hiding this comment.
Thanks for your contribution @lyushher!
Some of these edits are personal preference, like reuse or re-use. In these cases, I would stick with the current forms as I assume that's how Sebastián prefers them.
The clear typo's (tranlsation, reponse) we should definitely correct.
The "convertor" cases we should keep as-is, considering the way they're spelled in Starlette's and FastAPI's code bases.
So TLDR: I suggest to focus this PR on clear typo's only, so it'll be easier & quicker to merge.
| @@ -5342,7 +5342,7 @@ Note: all the previous parameters are still there, so it's still possible to dec | |||
| * New documentation about [dependencies in the `include_router()` method](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-prefix-tags-responses-and-dependencies). | |||
| * PR [#235](https://github.com/tiangolo/fastapi/pull/235). | |||
|
|
|||
| * Fix OpenAPI documentation of Starlette URL convertors. Specially useful when using `path` convertors, to take a whole path as a parameter, like `/some/url/{p:path}`. PR [#234](https://github.com/tiangolo/fastapi/pull/234) by [@euri10](https://github.com/euri10). | |||
| * Fix OpenAPI documentation of Starlette URL converters. Specially useful when using `path` converters, to take a whole path as a parameter, like `/some/url/{p:path}`. PR [#234](https://github.com/tiangolo/fastapi/pull/234) by [@euri10](https://github.com/euri10). | |||
There was a problem hiding this comment.
Here, we should stick to the spelling of convertors, as this is how Starlette spells it and how it's used in code:
from starlette.convertors import Convertor, register_url_convertor
| @@ -222,7 +222,7 @@ Nevertheless, you can still do it in **FastAPI**, using one of the internal tool | |||
|
|
|||
| And the docs would still work, although not adding any documentation telling that the parameter should contain a path. | |||
|
|
|||
| ### Path convertor | |||
| ### Path converter | |||
There was a problem hiding this comment.
Here as well, we should stick to convertor, to be consistent with the code base.
|
This pull request has a merge conflict that needs to be resolved. |
This PR addresses minor typographical errors and standardizes spelling across several English documentation files in FastAPI.
Changes are documentation-only and have no effect on runtime behavior.
Changes;
Docs-only PR — improves clarity and consistency without impacting functionality.