The Wayback Machine - https://web.archive.org/web/20200525112808/https://github.com/tiangolo/fastapi/issues/1234
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

[FEATURE] Remove *, where it's not needed #1234

Open
tiangolo opened this issue Apr 10, 2020 · 3 comments
Open

[FEATURE] Remove *, where it's not needed #1234

tiangolo opened this issue Apr 10, 2020 · 3 comments

Comments

@tiangolo
Copy link
Owner

@tiangolo tiangolo commented Apr 10, 2020

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. a Query() or Depends()) 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

@pankaj-giri
Copy link

@pankaj-giri pankaj-giri commented Apr 11, 2020

@tiangolo - Looking into it.. please assign #1234 to me.

pankaj-giri added a commit to pankaj-giri/fastapi that referenced this issue Apr 11, 2020
@chris-allnutt
Copy link
Contributor

@chris-allnutt chris-allnutt commented May 10, 2020

@pankaj-giri any updates?

@pankaj-giri
Copy link

@pankaj-giri pankaj-giri commented May 11, 2020

@chris-allnutt - I had submitted this pull request some-time ago..
#1239
Not sure why it wasn't merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.