You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
Line 5 and line 3 of these images are what I'm referring to. These screenshots are from the links above.
The text was updated successfully, but these errors were encountered:
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
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, butname
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. UsefullName
,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
Line 5 and line 3 of these images are what I'm referring to. These screenshots are from the links above.
The text was updated successfully, but these errors were encountered: