graphql-inspector icon indicating copy to clipboard operation
graphql-inspector copied to clipboard

Issues with how field descriptions are displayed

Open rbalicki2 opened this issue 9 months ago • 0 comments

  • All of the following (I think valid) descriptions either are not displayed fully or are formatted incorrectly, or both
type Query {
  """
  This renders correctly
  """
  correct: String

  """
  This line renders as bold
And from here onward is missing
  If there's anything lower spacing
  """
  noIndentation: String

  """
  Adding an empty line

  Also means that everything afterward is missing
  Probably because that line is auto-formatted to have no space?
  Note that the GraphQL spec has no opinion on the contents of multi-line strings, including wrt indentation
  """
  emptyLine: String

  """
  Adding three dashes
  ---
  Causes everything above the line to be rendered as if it were in backticks, and the three dashes onward to be excluded
  """
  dashes: String

  """
  # Title is the most important thing
  So that's why nothing after the title is rendered
  """
  title: String
}

That's all I found so far! Thank you!

rbalicki2 avatar Jan 30 '25 14:01 rbalicki2