In CKAN pull requests, put description last, on a new line #183
+4
−3
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
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.
Problem
Descriptions sent to CKAN pull requests are often long and markdown-formatted, but the formatting of the pull request puts them at the end of a line with a label, which may disrupt any markdown formatting. For example, if headings are present in pound sign format, they don't render on the first line. See KSP-CKAN/NetKAN#6197:
Similarly, it's not easy to tell where the description ends, because a footer line is appended without much visual distinction:
Changes
Now the description is the very last thing in the pull request, and it starts on a new line. The former footer is added before the mod details.