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

Support for descriptions #33

Closed
pekkah opened this issue May 19, 2019 · 8 comments
Closed

Support for descriptions #33

pekkah opened this issue May 19, 2019 · 8 comments
Labels
enhancement New feature or request spec compliance The change is intended to solve the problem of inconsistency with the official GraphQL specification

Comments

@pekkah
Copy link

pekkah commented May 19, 2019

So 4.0 added support for comments but it seems that comments should be ignored by the parser. Descriptions are what the spec uses for documentation. More here graphql/graphql-js#927 and here https://graphql.github.io/graphql-spec/June2018/#sec-Descriptions

@sungam3r
Copy link
Member

sungam3r commented Feb 6, 2020

Relates to graphql/graphql-spec#420

@pekkah
Copy link
Author

pekkah commented Apr 3, 2020

I have since implemented a new parser which handles the descriptions correctly so this is not an issue for me anymore. Please reopen if you want to track this as a feature request.

@pekkah pekkah closed this as completed Apr 3, 2020
@sungam3r
Copy link
Member

sungam3r commented Apr 3, 2020

Yes, I want to track this issue.

@prowe
Copy link

prowe commented Sep 15, 2020

We are also running into this issue, what would the steps be in adding support for this?

@sungam3r
Copy link
Member

Just as usual - PR, review, merge, publish, update dependent projects.

@sungam3r
Copy link
Member

Also see #124 :

var schema = Schema.For(@"""Root type for all queries""
type Query {
  ""Documentation for the field""
  name: String
}");

@Shane32
Copy link
Member

Shane32 commented Mar 11, 2021

@sungam3r At a minimum, we should ignore description fields, even if for a later version we actually parse them. I would say this should be done for 4.0 if we have the time. (Ok to release 4.0 now though; this can always just be an updated version of the parser engine, and we can release 4.0.1 to use the new parser.)

@sungam3r
Copy link
Member

sungam3r commented Nov 9, 2021

Support for descriptions was added in #132

@sungam3r sungam3r closed this as completed Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request spec compliance The change is intended to solve the problem of inconsistency with the official GraphQL specification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants