ChilliCream / ChilliCream/graphql-platform

Ability to specify default comment style

Open
#6,790 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

🌶️ hot chocolate Area: Type System
Dominant language
C#
Stars
5.8k
Forks
810
Avg merge
15h 39m
Merged PRs (30d)
98

Description

Product

Hot Chocolate

Is your feature request related to a problem?

At the moment comments or descriptions are single line

field("Some argument description" arg: String!): String

and only multiline

field(
  """
  Some 
  argument 
  description
  """ 
  arg: String!): String

if the description contains newline characters ("Some\nargument\ndescription").

The single line comments can make a schema harder to read, especially if they're long and apply to multiple arguments on a field.

The solution you'd like

I'd like to be able to specify that I want all comments to be printed as multiline in the schema, regardless of whether they contain newline characters or not.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named in the issue. Start by locating the GraphQL schema printer and the code that chooses single-line versus multiline descriptions, then identify existing printer tests. Done means a configurable default produces multiline comments even when descriptions contain no newline characters, while preserving the current behavior by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, graphql
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.