# no-hashtag-description

Source: https://api-genie.dev/docs/linter/graphql/rules/no-hashtag-description

A rule of the GraphQL linter, which reads GraphQL schemas and operations. Since 0.9.0. In the rulesets: Recommended at warning, Strict at error, All at error.

This rule checks that definitions are documented with descriptions rather than with `#` comments.

## Rule details

Comments are dropped by GraphQL servers: introspection, GraphiQL and generated code never show them. The rule reports a `#` comment directly above a definition that can have a description and has none. Comments separated from the definition by a blank line, and `apigenie-lint-disable` comments, are not reported.

The rule applies to definitions. An `# apigenie-lint-disable no-hashtag-description` comment on a
node turns it off for the node and everything nested in it; at the top of the file, separated from
the first definition by a blank line, the comment turns it off for the whole file.

## Examples

**Good**.

```graphql
"The users of the shop."
type User { id: ID! }
```

**Bad**. The linter reports `Use a description instead of a comment to document object type 'User'`.

```graphql
# The users of the shop.
type User { id: ID! }
```
