Typo/Bad wording in docs "FastAPI Path Parameters and Numeric Validations" page

[ccrenfroe]

First check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn't find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google "How to X in FastAPI" and didn't find any information. -- Unrelated
• I already read and followed all the tutorial in the docs and didn't find an answer. -- Unrelated
• I already checked if it is not related to FastAPI but to Pydantic. -- Unrelated
• I already checked if it is not related to FastAPI but to Swagger UI. -- Unrelated
• I already checked if it is not related to FastAPI but to ReDoc. -- Unrelated
• After submitting this, I commit to one of:
  • Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
  • I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
  • Implement a Pull Request for a confirmed bug.

Description

I believe there is a typo in the docs here! In the info box under the recap section, it states the following:

Query, Path, and others you will see later are subclasses of a common Param class (that you don't need to use).
And all of them share the same all these same parameters of additional validation and metadata you have seen.

Seems a bit hard to read, no?

[Kludex]

What do you suggest?

What do you think about the following:

"Query, Path, and others classes you will see later are subclasses of Param class (that you don't need to use).
And All of them share the same all these same parameters for of additional validation and metadata, that you have already seen."

Maybe removing also this "that you have already seen"?

Either way, a PR should be welcome, the current text is really confusing. 😅

[ccrenfroe]

I think that would work great! That is much more clear to me. 😄

So far, I think the text has been very nice, especially as someone new to developing APIs.

I'll gladly put up a PR for this if that is alright?

[Kludex]

I'll gladly put up a PR for this if that is alright?

I don't have merge rights, but I think it will be highly appreciated! :)

[ccrenfroe]

I put up a PR for the doc change. I'll go ahead and close this issue since it has been addressed and a change proposed.

Thanks for your time and suggestion! ✌️

[tiangolo]

Thanks for the help here @Kludex ! 👏 🙇

Thanks for reporting back and closing the issue @ccrenfroe 👍

Sorry for the long delay! 🙈 I wanted to personally address each issue/PR and they piled up through time, but now I'm checking each one in order.