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

[Documentation] Don't use "name" field for hello world example #1230

Closed
alexanderqchen opened this issue Jul 15, 2020 · 1 comment · Fixed by #1474
Closed

[Documentation] Don't use "name" field for hello world example #1230

alexanderqchen opened this issue Jul 15, 2020 · 1 comment · Fixed by #1474

Comments

@alexanderqchen
Copy link

Is your feature request related to a problem? Please describe.
I'm a new user and while reading through the getting started page of the docs, I was confused by the name input into the Scalar. name here acts as an input for the resolver, but name is also used to set a custom name for the field.

Here are the two different uses for name within the first 1 pages of docs:
https://docs.graphene-python.org/en/latest/quickstart/#creating-a-basic-schema
https://docs.graphene-python.org/en/latest/types/schema/#auto-camelcase-field-names

Describe the solution you'd like
Don't use the input name on the getting started page in the documentation. Use fullName, firstName, etc. instead.

Describe alternatives you've considered
Another option is to mention this behavior in the docs when introducing custom field names, but I feel like this would be less concise.

Additional context
image
image
Line 5 and line 3 of these images are what I'm referring to. These screenshots are from the links above.

@alexanderqchen alexanderqchen changed the title Don't use "name" field for hello world example [Documentation] Don't use "name" field for hello world example Jul 15, 2020
@jkimbo
Copy link
Member

jkimbo commented Jul 15, 2020

This is a very good point @alexanderqchen , thanks for raising.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants