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

Always prepend directive names with @ #203

Open
ddebrunner opened this issue Mar 29, 2023 · 1 comment
Open

Always prepend directive names with @ #203

ddebrunner opened this issue Mar 29, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ddebrunner
Copy link

Describe what is missing

In GraphQL directives are always used with @, even when defined, e.g. @include.

When magidoc documents them it displays them without the at-sign, to me it's jarring and means that when I look at the list it's not immediately obvious the context is a directive.

So adding @ signs like this (not in red though!)

image (1)

@ddebrunner ddebrunner added the documentation Improvements or additions to documentation label Mar 29, 2023
@pelletier197
Copy link
Collaborator

Hi @ddebrunner sorry for the late reply. This is a great suggestion. Would you be interested in contributing and try to implement it in a PR?

I would mind a little color for the @ if you want, otherwise it might look bland if it's just all black, but I leave it up to you to decide 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants