graphql / graphql/graphql.github.io

Schema Design: Use triple quotes for descriptions

Open
#2,355 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
889
Forks
1.5k
Avg merge
4d 12h
Merged PRs (30d)
21

Description

Use triple-quote syntax (`"""description"""`) for field and type documentation, not `#` symbols.

Rationale: Triple quotes are parsed as descriptions and appear in introspection and documentation tools. Hash comments are ignored by the parser and invisible to consumers.

**Example:**

Prefer:
```
"""
The business name
"""
name: String
```

Not:
```
# The business name
name: String
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.