Use common Markdown for descriptions #290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wincent
reviewed
Mar 28, 2017
spec/Section 4 -- Introspection.md
Outdated
| @@ -74,9 +74,9 @@ underscores. | |||
|
|
|||
| All types in the introspection system provide a `description` field of type | |||
| `String` to allow type designers to publish documentation in addition to | |||
| capabilities. A GraphQL server may return the `description` field using Markdown | |||
| capabilities. A GraphQL server may return the `description` field using [Common Markdown](http://spec.commonmark.org/) | |||
There was a problem hiding this comment.
Seems like this long line would best be wrapped.
|
And for reference, I looked up this GitHub blog post on the subject of the Markdown spec. |
|
Ok, going to apply a couple of tweaks and merge this (namely, that the spec is called "CommonMark" and doesn't refer to "Common Markdown"). Thanks! |
- Link to http://commonmark.org/ rather than http://spec.commonmark.org/ as it provides a more user-friendly landing point. - "Common Markdown" → "CommonMark" - Backticks around "description".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a lot of different Markdown dialects. Let's stick to Common Markdown as it was recently done by GitHub and others.
I believe most of markdown renderers will support soon or already support Common Markdown.