Add documentation on NonNull lists

This commit is contained in:
Jonathan Kim 2018-02-07 12:06:29 -08:00
parent e94716d94a
commit e26c0a3717

View File

@ -48,3 +48,24 @@ Lists work in a similar way: We can use a type modifier to mark a type as a
``List``, which indicates that this field will return a list of that type. ``List``, which indicates that this field will return a list of that type.
It works the same for arguments, where the validation step will expect a list It works the same for arguments, where the validation step will expect a list
for that value. for that value.
NonNull Lists
-------------
By default items in a list will be considered nullable. To define a list without
any nullable items the type needs to be marked as ``NonNull``. For example:
.. code:: python
import graphene
class Character(graphene.ObjectType):
appears_in = graphene.List(graphene.NonNull(graphene.String))
The above results in the type definition:
.. code::
type Character {
appearsIn: [String!]
}