Skip to content

Schema Design: Use triple quotes for descriptions #2355

@magicmark

Description

@magicmark

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions