Skip to content
This repository has been archived by the owner on Jul 8, 2019. It is now read-only.

Change in description comments to be string literals per GraphQL spec. #27

Open
3 tasks
elmiguel opened this issue May 9, 2019 · 0 comments
Open
3 tasks

Comments

@elmiguel
Copy link

elmiguel commented May 9, 2019

Change in description comments to be string literals per GraphQL spec.

Details

Per the spec in GraphQL code base:
/**

  • Descriptions are defined as preceding string literals, however an older
  • experimental version of the SDL supported preceding comments as
  • descriptions. Set to true to enable this deprecated behavior.
  • This option is provided to ease adoption and will be removed in v16.
  • Default: false
    */

All description comments should be encapsulated around string literals, more specifically triple double quotes:
""" Description here """

Additional Information

I used your package to convert a swagger file from a third party API and there are a few things that needed to be done. This package does not recheck the return gql for malformations. I had to scan through the file and check to see if there was multi-line 'comments' and to rebuild it accordingly.

Link to comment in code base:
extendSchema#L47

Issue Checklist

  • Maintainer has viewed
  • Loaded into Backlog
  • PR submitted [Link Here](Eventual Link)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant