Graphql-yoga: type and field descriptions?

[cj]

According to https://stackoverflow.com/questions/39962867/how-do-i-add-a-description-to-a-field-in-graphql-schema-language you should be able to do:

# A type that describes the user
type User {
     # The user's username, should be typed in the login field.
     username: String!
     # The user's password.
     password: String!
}

Shouldn't this add A type that describes the user here?

[kbrandwijk]

That's the old syntax for comments/descriptions. Since graphql 0.12, you should now use """ for descriptions. So:

"""A type that describes the user"""
type User {
     """The user's username, should be typed in the login field."""
     username: String!
     """The user's password."""
     password: String!
}

I have just tested this syntax with the latest graphql-playground (that comes with graphql-yoga), and the descriptions show up, if you use this new syntax.

[schickling]

Thanks for helping out @kbrandwijk 👍

[schickling]

We should probably add some documentation about this for GraphQL Playground.