noHashtagDescription
| Property | Value |
|---|---|
| Config name | noHashtagDescription |
| Default severity | warn |
| Context | Schema |
| In recommended | Yes |
What it checks
Section titled “What it checks”Disallow # comments as type descriptions.
Examples
Section titled “Examples”# ❌ Bad — comment used as description# A user typetype User { id: ID!}# ✅ Good — proper description string"A user type"type User { id: ID!}Configuration
Section titled “Configuration”extensions: graphql-analyzer: lint: rules: noHashtagDescription: warn