Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up[FEATURE] Remove *, where it's not needed #1234
Open
Labels
Comments
|
@pankaj-giri any updates? |
|
@chris-allnutt - I had submitted this pull request some-time ago.. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment


Is your feature request related to a problem
Coming from this issue: #817
The docs have some sections with functions using
*,in the parameters.It is explained here: https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#order-the-parameters-as-you-need-tricks
But in other sections like: https://fastapi.tiangolo.com/tutorial/response-model/ the
*,is not really needed and would probably just cause some confusion.The solution you would like
Remove the
*,from function parameters in the docs at the places where it's not needed, i.e. the places where a function parameter with a default (e.g. aQuery()orDepends()) does NOT come before a function parameter without a default value.Describe alternatives you've considered
Leaving it as is. But, as always, I want the docs to be as easy and friendly as possible.
Additional context
This issue: #817