Data Package: Reference CommonMark #1067
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
The `description` is CommonMark by definition, so the word `MUST` is not approriate. The first paragraph in a CommonMarkd document does not necessarily end with two line breaks, for instance it can directly be followed by one line break and a heading! This should better be a recommendation to allow splitting it from the rest of the text without use of a full-featured Markdown parser.
peterdesmet
approved these changes
Dec 16, 2024
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.
The
descriptionis CommonMark by definition, so the wordMUSTis not approriate. The first paragraph in a CommonMarkd document does not necessarily end with two line breaks, for instance it can directly be followed by one line break and a heading! This should better be a recommendation to allow splitting it from the rest of the text without use of a full-featured Markdown parser.fixes #1065