📝 Fix typo in docs/en/docs/contributing.md
#9878
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
📝 Docs preview for commit 8d69d4b at: https://64b0acfb0c3c5e6ca2074467--fastapi.netlify.app |
lieryan
approved these changes
Jul 18, 2023
Kludex
approved these changes
Jul 18, 2023
docs/en/docs/contributing.md
|
Nice, thanks! 🤓 ☕ |
magiskboy
pushed a commit
to magiskboy/fastapi
that referenced
this pull request
Aug 15, 2023
Co-authored-by: Vicente Merino <vmerino@rexmas.com>
emirthab
pushed a commit
to emirthab/fastapi
that referenced
this pull request
Sep 1, 2023
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.1.17 to 9.1.21. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](squidfunk/mkdocs-material@9.1.17...9.1.21) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> 📝 Update release notes 🔖 Release version 0.103.0 📝 Update release notes 📝 Update release notes ✨ Add support for `openapi_examples` in all FastAPI parameters (fastapi#10152) * ♻️ Refactor model for OpenAPI Examples to use a reusable TypedDict * ✨ Add support for openapi_examples in parameters * 📝 Add new docs examples for new parameter openapi_examples * 📝 Update docs for Schema Extra to include OpenAPI examples * ✅ Add tests for new source examples, for openapi_examples * ✅ Add tests for openapi_examples corner cases and all parameters * 💡 Tweak and ignore type annotation checks for custom TypedDict 📝 Update release notes 📝 Add note to docs about Separate Input and Output Schemas with FastAPI version (fastapi#10150) 📝 Update release notes 🔖 Release version 0.102.0 📝 Update release notes 📝 Update release notes ✨ Add support for disabling the separation of input and output JSON Schemas in OpenAPI with Pydantic v2 (fastapi#10145) * 📝 Add docs for Separate OpenAPI Schemas for Input and Output * 🔧 Add new docs page to MkDocs config * ✨ Add separate_input_output_schemas parameter to FastAPI class * 📝 Add source examples for separating OpenAPI schemas * ✅ Add tests for separated OpenAPI schemas * 📝 Add source examples for Python 3.10, 3.9, and 3.7+ * 📝 Update docs for Separate OpenAPI Schemas with new multi-version examples * ✅ Add and update tests for different Python versions * ✅ Add tests for corner cases with separate_input_output_schemas * 📝 Update tutorial to use Union instead of Optional * 🐛 Fix type annotations * 🐛 Fix correct import in test * 💄 Add CSS to simulate browser windows for screenshots * ➕ Add playwright as a dev dependency to automate generating screenshots * 🔨 Add Playwright scripts to generate screenshots for new docs * 📝 Update docs, tweak text to match screenshots * 🍱 Add screenshots for new docs 📝 Update release notes 📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (fastapi#10114) * 📝 Start How To docs section, move Peewee, remove Peewee from dependencies * 🚚 Move em files to new locations * 🚚 Move and re-structure advanced docs, move relevant to How To * 🔧 Update MkDocs config, new files in How To * 📝 Move docs for Conditional OpenAPI for Japanese to How To * 📝 Move example source files for Extending OpenAPI into each of the new sections * ✅ Update tests with new locations for source files * 🔥 Remove init from Peewee examples 📝 Update release notes ♻️ Refactor tests for new Pydantic 2.2.1 (fastapi#10115) 📝 Update release notes 📝 Update Advanced docs, add links to sponsor courses (fastapi#10113) 📝 Update release notes 📝 Update docs for generating clients (fastapi#10112) 📝 Update release notes 📝 Tweak MkDocs and add redirects (fastapi#10111) 📝 Update release notes 📝 Restructure docs for cloud providers, include links to sponsors (fastapi#10110) 📝 Update release notes 🔧 Update sponsors, add Speakeasy (fastapi#10098) 🔖 Release version 0.101.1 📝 Update release notes 📝 Update release notes ✨ Add `ResponseValidationError` printable details, to show up in server error logs (fastapi#10078) 📝 Update release notes 📝 Update release notes 🌐 Add Japanese translation for `docs/ja/docs/deployment/concepts.md` (fastapi#10062) 🌐 Add Japanese translation for `docs/ja/docs/deployment/server-workers.md` (fastapi#10064) 📝 Update release notes 🌐 Update Japanese translation for `docs/ja/docs/deployment/docker.md` (fastapi#10073) 📝 Update release notes 🌐 Add Ukrainian translation for `docs/uk/docs/fastapi-people.md` (fastapi#10059) 📝 Update release notes 🌐 Add Ukrainian translation for `docs/uk/docs/tutorial/cookie-params.md` (fastapi#10032) 📝 Update release notes 🌐 Add Russian translation for `docs/ru/docs/deployment/docker.md` (fastapi#9971) 📝 Update release notes 🌐 Add Vietnamese translation for `docs/vi/docs/python-types.md` (fastapi#10047) 📝 Update release notes 🔧 Add sponsor Porter (fastapi#10051) 📝 Update release notes 🔧 Update sponsors, add Jina back as bronze sponsor (fastapi#10050) 📝 Update release notes 📝 Update release notes 📝 Update release notes ✏️ Fix typo in deprecation warnings in `fastapi/params.py` (fastapi#9854) fix typo for deprecation warnings depreacated -> deprecated ✏️ Fix typo in release notes (fastapi#9835) ✏️ Fix typos in comments on internal code in `fastapi/concurrency.py` and `fastapi/routing.py` (fastapi#9590) 📝 Update release notes 📝 Update release notes 📝 Add external article: Build an SMS Spam Classifier Serverless Database with FaunaDB and FastAPI (fastapi#9847) 📝 Update release notes 📝 Fix typo in `docs/en/docs/contributing.md` (fastapi#9878) 📝 Fix code highlighting in `docs/en/docs/tutorial/bigger-applications.md` (fastapi#9806) Update bigger-applications.md 📝 Update release notes 📝 Update release notes 🌐 Add Russian translation for `docs/ru/docs/tutorial/dependencies/global-dependencies.md` (fastapi#9970) 🌐 Add Urdu translation for `docs/ur/docs/benchmarks.md` (fastapi#9974) 📝 Update release notes 📝 Update release notes ⬆ Bump mypy from 1.4.0 to 1.4.1 (fastapi#9756) Bumps [mypy](https://github.com/python/mypy) from 1.4.0 to 1.4.1. - [Commits](python/mypy@v1.4.0...v1.4.1) --- updated-dependencies: - dependency-name: mypy dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-Authored-By: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-Authored-By: Yois4101 <119609381+Yois4101@users.noreply.github.com> Co-Authored-By: Marcelo Trylesinski <marcelotryle@gmail.com> Co-Authored-By: Vicente Merino <vmerino@rexmas.com> Co-Authored-By: dedkot <dedkot01@gmail.com> Co-Authored-By: Vladislav Kramorenko <85196001+Xewus@users.noreply.github.com> Co-Authored-By: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
emirthab
pushed a commit
to emirthab/fastapi
that referenced
this pull request
Sep 1, 2023
Revert "Add Json Support To Params" This reverts commit 0ed16c0. Add Json Support To Params Add Json Support To Params 📝 Update release notes 🔖 Release version 0.103.0 📝 Update release notes 📝 Update release notes ✨ Add support for `openapi_examples` in all FastAPI parameters (fastapi#10152) * ♻️ Refactor model for OpenAPI Examples to use a reusable TypedDict * ✨ Add support fo 8000 r openapi_examples in parameters * 📝 Add new docs examples for new parameter openapi_examples * 📝 Update docs for Schema Extra to include OpenAPI examples * ✅ Add tests for new source examples, for openapi_examples * ✅ Add tests for openapi_examples corner cases and all parameters * 💡 Tweak and ignore type annotation checks for custom TypedDict 📝 Update release notes 📝 Add note to docs about Separate Input and Output Schemas with FastAPI version (fastapi#10150) 📝 Update release notes 🔖 Release version 0.102.0 📝 Update release notes 📝 Update release notes ✨ Add support for disabling the separation of input and output JSON Schemas in OpenAPI with Pydantic v2 (fastapi#10145) * 📝 Add docs for Separate OpenAPI Schemas for Input and Output * 🔧 Add new docs page to MkDocs config * ✨ Add separate_input_output_schemas parameter to FastAPI class * 📝 Add source examples for separating OpenAPI schemas * ✅ Add tests for separated OpenAPI schemas * 📝 Add source examples for Python 3.10, 3.9, and 3.7+ * 📝 Update docs for Separate OpenAPI Schemas with new multi-version examples * ✅ Add and update tests for different Python versions * ✅ Add tests for corner cases with separate_input_output_schemas * 📝 Update tutorial to use Union instead of Optional * 🐛 Fix type annotations * 🐛 Fix correct import in test * 💄 Add CSS to simulate browser windows for screenshots * ➕ Add playwright as a dev dependency to automate generating screenshots * 🔨 Add Playwright scripts to generate screenshots for new docs * 📝 Update docs, tweak text to match screenshots * 🍱 Add screenshots for new docs 📝 Update release notes 📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (fastapi#10114) * 📝 Start How To docs section, move Peewee, remove Peewee from dependencies * 🚚 Move em files to new locations * 🚚 Move and re-structure advanced docs, move relevant to How To * 🔧 Update MkDocs config, new files in How To * 📝 Move docs for Conditional OpenAPI for Japanese to How To * 📝 Move example source files for Extending OpenAPI into each of the new sections * ✅ Update tests with new locations for source files * 🔥 Remove init from Peewee examples 📝 Update release notes ♻️ Refactor tests for new Pydantic 2.2.1 (fastapi#10115) 📝 Update release notes 📝 Update Advanced docs, add links to sponsor courses (fastapi#10113) 📝 Update release notes 📝 Update docs for generating clients (fastapi#10112) 📝 Update release notes 📝 Tweak MkDocs and add redirects (fastapi#10111) 📝 Update release notes 📝 Restructure docs for cloud providers, include links to sponsors (fastapi#10110) 📝 Update release notes 🔧 Update sponsors, add Speakeasy (fastapi#10098) 🔖 Release version 0.101.1 📝 Update release notes 📝 Update release notes ✨ Add `ResponseValidationError` printable details, to show up in server error logs (fastapi#10078) 📝 Update release notes 📝 Update release notes 🌐 Add Japanese translation for `docs/ja/docs/deployment/concepts.md` (fastapi#10062) 🌐 Add Japanese translation for `docs/ja/docs/deployment/server-workers.md` (fastapi#10064) 📝 Update release notes 🌐 Update Japanese translation for `docs/ja/docs/deployment/docker.md` (fastapi#10073) 📝 Update release notes 🌐 Add Ukrainian translation for `docs/uk/docs/fastapi-people.md` (fastapi#10059) 📝 Update release notes 🌐 Add Ukrainian translation for `docs/uk/docs/tutorial/cookie-params.md` (fastapi#10032) 📝 Update release notes 🌐 Add Russian translation for `docs/ru/docs/deployment/docker.md` (fastapi#9971) 📝 Update release notes 🌐 Add Vietnamese translation for `docs/vi/docs/python-types.md` (fastapi#10047) 📝 Update release notes 🔧 Add sponsor Porter (fastapi#10051) 📝 Update release notes 🔧 Update sponsors, add Jina back as bronze sponsor (fastapi#10050) 📝 Update release notes 📝 Update release notes 📝 Update release notes ✏️ Fix typo in deprecation warnings in `fastapi/params.py` (fastapi#9854) fix typo for deprecation warnings depreacated -> deprecated ✏️ Fix typo in release notes (fastapi#9835) ✏️ Fix typos in comments on internal code in `fastapi/concurrency.py` and `fastapi/routing.py` (fastapi#9590) 📝 Update release notes 📝 Update release notes 📝 Add external article: Build an SMS Spam Classifier Serverless Database with FaunaDB and FastAPI (fastapi#9847) 📝 Update release notes 📝 Fix typo in `docs/en/docs/contributing.md` (fastapi#9878) 📝 Fix code highlighting in `docs/en/docs/tutorial/bigger-applications.md` (fastapi#9806) Update bigger-applications.md 📝 Update release notes 📝 Update release notes 🌐 Add Russian translation for `docs/ru/docs/tutorial/dependencies/global-dependencies.md` (fastapi#9970) 🌐 Add Urdu translation for `docs/ur/docs/benchmarks.md` (fastapi#9974) 📝 Update release notes 📝 Update release notes ⬆ Bump mypy from 1.4.0 to 1.4.1 (fastapi#9756) Bumps [mypy](https://github.com/python/mypy) from 1.4.0 to 1.4.1. - [Commits](python/mypy@v1.4.0...v1.4.1) --- updated-dependencies: - dependency-name: mypy dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> ⬆ Bump mkdocs-material from 9.1.17 to 9.1.21 (fastapi#9960) Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.1.17 to 9.1.21. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](squidfunk/mkdocs-material@9.1.17...9.1.21) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> 🔖 Release version 0.101.0 📝 Update release notes 📝 Update release notes 📌 Do not allow Pydantic 2.1.0 that breaks (require 2.1.1) (fastapi#10012) 📝 Update release notes 📝 Update release notes ✨ Enable Pydantic's serialization mode for responses, add support for Pydantic's `computed_field`, better OpenAPI for response models, proper required attributes, better generated clients (fastapi#10011) * ✨ Enable Pydantic's serialization mode for responses * ✅ Update tests with new Pydantic v2 serialization mode * ✅ Add a test for Pydantic v2's computed_field 📝 Update release notes 👷 Add GitHub Actions step dump context to debug external failures (fastapi#10008) 📝 Update release notes 🔧 Restore MkDocs Material pin after the fix (fastapi#10001) 📝 Update release notes 🔧 Update the Question template to ask for the Pydantic version (fastapi#10000) 📝 Update release notes ✅ Fix tests for compatibility with pydantic 2.1.1 (fastapi#9943) 📝 Update release notes ➖ Remove direct dependency on MkDocs, Material for MkDocs defines its own dependency (fastapi#9986) 📝 Update release notes 👥 Update FastAPI People (fastapi#9999) 📝 Update release notes 🐳 Update Dockerfile with compatibility versions, to upgrade later (fastapi#9998) 📝 Update release notes ➕ Add pydantic-settings to FastAPI People dependencies (fastapi#9988) 📝 Update release notes ♻️ Update FastAPI People logic with new Pydantic (fastapi#9985) 📝 Update release notes ✅ Fix test error in Windows for `jsonable_encoder` (fastapi#9840) 📝 Update release notes 🌐 Add Russian translation for `docs/ru/docs/tutorial/security/index.md` (fastapi#9963) 📝 Update release notes 🍱 Update sponsors, Fern badge (fastapi#9982) 📝 Update release notes 👷 Deploy docs to Cloudflare Pages (fastapi#9978) 📝 Update release notes 🔧 Update sponsor Fern (fastapi#9979) 📝 Update release notes 👷 Update CI debug mode with Tmate (fastapi#9977) 📝 Update release notes Co-Authored-By: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-Authored-By: Yois4101 <119609381+Yois4101@users.noreply.github.com> Co-Authored-By: Marcelo Trylesinski <marcelotryle@gmail.com> Co-Authored-By: Vicente Merino <vmerino@rexmas.com> Co-Authored-By: dedkot <dedkot01@gmail.com> Co-Authored-By: Vladislav Kramorenko <85196001+Xewus@users.noreply.github.com> Co-Authored-By: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-Authored-By: Sebastián Ramírez <tiangolo@gmail.com> Co-Authored-By: github-actions <github-actions@github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
509C
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix typo in /contributing section:
requiements.txt->requirements.txt