Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues with how field descriptions are displayed #2843

Open
rbalicki2 opened this issue Jan 30, 2025 · 0 comments
Open

Issues with how field descriptions are displayed #2843

rbalicki2 opened this issue Jan 30, 2025 · 0 comments
Labels

Comments

@rbalicki2
Copy link

  • 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!

@dotansimha dotansimha added the core label Feb 11, 2025 — with Linear
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants