Tweak the documentation to match behavior in the playground.

This commit is contained in:
Wenley Tong 2016-10-16 11:30:51 -07:00
parent 88ccaec8fa
commit 77e4ead0d7

View File

@ -1,7 +1,7 @@
Scalars
=======
Graphene define the following base Scalar Types:
Graphene defines the following base Scalar Types:
- ``graphene.String``
- ``graphene.Int``
@ -47,8 +47,8 @@ The following is an example for creating a DateTime scalar:
Mounting Scalars
----------------
This scalars if are mounted in a ``ObjectType``, ``Interface`` or
``Mutation``, would act as ``Field``\ s.
These scalars, if are mounted in a ``ObjectType``, ``Interface`` or
``Mutation``, act as ``Field``\ s. Note: when using the ``Field`` constructor directly, pass the type and not an instance.
.. code:: python
@ -57,14 +57,14 @@ This scalars if are mounted in a ``ObjectType``, ``Interface`` or
# Is equivalent to:
class Person(graphene.ObjectType):
name = graphene.Field(graphene.String())
name = graphene.Field(graphene.String)
If the types are mounted in a ``Field``, would act as ``Argument``\ s.
.. code:: python
graphene.Field(graphene.String(), to=graphene.String())
graphene.Field(graphene.String, to=graphene.String())
# Is equivalent to:
graphene.Field(graphene.String(), to=graphene.Argument(graphene.String()))
graphene.Field(graphene.String, to=graphene.Argument(graphene.String()))