-
Notifications
You must be signed in to change notification settings - Fork 101
How to document a query for the schema? #265
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
Comments
Exactly, the comment from your PHP code queries/fields is propagated to the schema. When you say "not properly formatted", you are referring to the "new line" in front of the comment, right? |
(also, congrats on your first issue on Github! π ) π |
Thanks π Yeah I didn't find any hint on where to comment to get it to the schema. |
A really nice feature to have would also be to be able to document the parameters for a function, as by now the PHPDoc gets ignored for paramters and is not parsed into the schema. Or is there already a way to do it and we're doing it wrong? |
Indeed, pretty good idea! |
Duplicate of #289 |
Is there a way to add comments to queries, types etc. so they come up in the schema.graphql?
Like in this example from Magento:

The text was updated successfully, but these errors were encountered: