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

Attribute not documented #212

Open
andushow opened this issue Aug 21, 2020 · 2 comments
Open

Attribute not documented #212

andushow opened this issue Aug 21, 2020 · 2 comments

Comments

@andushow
Copy link

Having run grapfdoc, it produced the expected output with the existing types (objects).
The output says that the Arguments are not documented; any advice on how to document them ?
Clipboard01

@andushow
Copy link
Author

andushow commented Aug 21, 2020

I found this (Chapter 4.2):
https://spec.graphql.org/June2018/#sec-Field-Arguments

"All types in the introspection system provide a description field of type String to allow type designers to publish documentation in addition to capabilities. A GraphQL server may return the description field using Markdown syntax (as specified by CommonMark). Therefore it is recommended that any tool that displays description use a CommonMark‐compliant Markdown renderer."

Is this the field missing (description) ?

@ab-tools
Copy link

ab-tools commented Apr 4, 2021

Yes.

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

2 participants