Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

SaisakthiM
Copy link

Description

This PR improves the clarity of a documentation note inside a <small> tag:

  • Before:
    * estimation based on tests on an internal development team, building production applications.

  • After:
    * estimation based on tests conducted by an internal development team, building production applications.

The change corrects the wording to better describe the context while keeping the <small> styling intact.

Pull Request type

  • Documentation

Notes

This is a minor documentation update and does not affect any code functionality.

@SaisakthiM
Copy link
Author

SaisakthiM commented Sep 11, 2025

Note: The tag was kept intentionally for styling consistency.
This is a docs-only change; only the content inside the tag was corrected.
The CI flagged it as failing, but it does not affect the functionality or content of the documentation.

@@ -40,7 +40,7 @@ The key features are:
* **Robust**: Get production-ready code. With automatic interactive documentation.
* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (previously known as Swagger) and <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.

<small>* estimation based on tests on an internal development team, building production applications.</small>
<small>* estimation based on tests conducted by an internal development team, building production applications.</small>

Choose a reason for hiding this comment

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

Yeah, it's correct!

Copy link

@saky-semicolon saky-semicolon left a comment

Choose a reason for hiding this comment

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

Both sentences read well, but the second one (“conducted by”) is a bit clearer and more formal than the first. I’d suggest going with the second version for better readability.

@svlandeg svlandeg changed the title docs: clarify estimation note in docs 📝 Clarify estimation note in documentation Sep 12, 2025
@svlandeg svlandeg added the docs Documentation about how to use FastAPI label Sep 12, 2025
@svlandeg
Copy link
Member

The CI flagged it as failing, but it does not affect the functionality or content of the documentation.

It's always a good idea to go and read why the CI is failing 😉

In this case:

image

What this means, is that index.md should get the same edit.

@svlandeg svlandeg marked this pull request as draft September 12, 2025 10:06
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 waiting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants