8000 📝 Several docs improvements, tweaks, and clarifications by nilslindemann · Pull Request #11390 · fastapi/fastapi · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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

📝 Several docs improvements, tweaks, and clarifications #11390

Merged
merged 6 commits into from
Aug 15, 2024

Conversation

nilslindemann
Copy link
Contributor

These are more ambiguous changes subtracted from #11389. Smaller PR, but look more closely. The first two commits are improvements in my opinion. I am unsure about the third commit.

@alejsdev alejsdev added the docs Documentation about how to use FastAPI label Apr 2, 2024
@svlandeg svlandeg self-assigned this Aug 9, 2024
@svlandeg
Copy link
Member
svlandeg commented Aug 9, 2024

Hi @nilslindemann, thanks for the PR! Especially appreciate you breaking out more ambiguous changes into its separate PR & commit - these kind of considerations certainly help us push "less ambiguous" fixes through more easily 🙏

I'll get this PR updated with the latest of master and will then review the changes.

Copy link
Contributor
github-actions bot commented Aug 9, 2024

📝 Docs preview for commit 00e4a23 at: https://5158d7cb.fastapitiangolo.pages.dev

Modified Pages

Copy link
Member
@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

These edits mostly look good to me. Rewriting words like "it" to more clear references helps with readability for new users as well, so I'm all for it.

Also really appreciate you checking all links and rewriting them to better suited links where relevant 🙏

docs/en/docs/advanced/openapi-callbacks.md Show resolved Hide resolved
docs/en/docs/help-fastapi.md Show resolved Hide resolved
docs/en/docs/tutorial/cookie-params.md Outdated Show resolved Hide resolved
docs/en/docs/tutorial/header-params.md Outdated Show resolved Hide resolved
@svlandeg svlandeg assigned tiangolo and unassigned svlandeg and tiangolo Aug 14, 2024
@tiangolo tiangolo changed the title Doc improvements (ambiguous) 📝 Several docs improvements, tweaks, and clarifications Aug 15, 2024
@tiangolo
Copy link
Member

Awesome, thanks a lot for this @nilslindemann! 🚀 You rock! 🎸

And thanks a lot @svlandeg for the thorough review! 🙇

I tweaked a couple of places and included Sofie's suggestions, this is now ready. Thank you! 🍰

@tiangolo tiangolo enabled auto-merge (squash) August 15, 2024 23:27
@tiangolo tiangolo merged commit 8809b36 into fastapi:master Aug 15, 2024
48 checks passed
black-redoc pushed a commit to black-redoc/fastapi that referenced this pull request Aug 16, 2024
Co-authored-by: svlandeg <svlandeg@github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
black-redoc pushed a commit to black-redoc/fastapi that referenced this pull request Aug 17, 2024
Co-authored-by: svlandeg <svlandeg@github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
@nilslindemann
Copy link
Contributor Author

Thanks people, especially @svlandeg! I know this was quite some work. Well done!

@nilslindemann nilslindemann deleted the ambiguous-doc-improvements branch August 19, 2024 18:16
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.

4 participants
0