# description-style

Source: https://apigenie.pl/docs/linter/graphql/rules/description-style

This rule checks that descriptions are written as block strings, or as single-line strings.

## Rule Details

One style of descriptions makes a schema easier to read and to diff. Block strings (`"""..."""`) are the default, as they allow descriptions to grow over several lines.

## Configuration

The configuration block can be a string, `block` or `inline`, or an object with the
`style` property.

```yaml
version: "1.0"
commands:
  lint:
    graphql:
      rules:
        description-style: [error, inline]
```

The rule can be disabled for a node and everything nested in it with an `# apigenie-lint-disable description-style` comment on the node, or for a whole file with the comment at the top of the file, separated from the first definition by a blank line. It applies to definitions.

## Examples

**Good**.

```graphql
"""
A user of the shop.
"""
type User { id: ID! }
```

**Bad**. The linter reports `The description of object type 'User' should be a block string ("""...""")`.

```graphql
"A user of the shop."
type User { id: ID! }
```