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

How to add description? #3

Closed
donaldjarmstrong opened this issue Aug 12, 2016 · 2 comments
Closed

How to add description? #3

donaldjarmstrong opened this issue Aug 12, 2016 · 2 comments

Comments

@donaldjarmstrong
Copy link

donaldjarmstrong commented Aug 12, 2016

Are adding descriptions supported? I have not seen any examples on how to add description to types and fields. Maybe...?

type User {
id: ID! # field description
name: String # A cool name for this user
}

@gajus
Copy link

gajus commented Aug 31, 2016

Adding description is going to be implementation specific. If you are using graphql-js, then support for adding description via comments has been added in v0.7.

See https://medium.com/apollo-stack/all-you-need-to-know-about-graphql-js-0-7-921e75dd7fd1#.t9csdknur

sogko added a commit that referenced this issue Jan 27, 2017
Commited previous versions, just because.
@sogko
Copy link
Owner

sogko commented Jan 27, 2017

Hi guys,

I've added examples of comments usage, though like @gajus said, it is specific to the tool implementation. It would be useful to document your schema.

Thanks!

@sogko sogko closed this as completed Jan 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants