hasura / hasura/graphql-engine

[feature request] multi-line table description

Open
#7,714 0 comments 0 reactions 0 assignees View on GitHub
k/enhancement
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

### Is your proposal related to a problem?

I love the ability to write descriptions for each of my tables, however it's limiting to be forced into a single-line comment. Could we turn these into multi-line strings?

### Describe the solution you'd like

Support for multi-line table descriptions.

### Describe alternatives you've considered

Providing links to more verbose descriptions/documentation elsewhere.

### If the feature is approved, would you be willing to submit a PR?

sure, assuming it's not an engineering nightmare

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named in the issue. Start by locating the existing table-description handling and determine how multi-line descriptions should be represented and exposed; done means table descriptions can contain multiple lines without requiring external documentation links.

Written by the indexing model from the issue text.

Assessment

Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.