Reformat XML documents to 100 columns length #308
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
When possible wrap text to 100 columns as it seems to be the convention in recent changes and is probably a good compromise.
handrews
suggested changes
Apr 20, 2017
jsonschema-core.xml
Outdated
| <xref target="RFC6906">The 'profile' Link Relation</xref>. | ||
| When used as a media-type parameter, HTTP servers gain the ability to perform | ||
| Content-Type Negotiation based on profile. | ||
| The media-type parameter MUST be a whitespace-separated list of URIs (i.e. |
There was a problem hiding this comment.
It seems that if a line ends in a period then the .txt generator automatically puts two spaces after that period. It can't tell the difference between an abbreviation and the end of a sentence.
Could you please move the "(i.e." down to the beginning of the next line?
There was a problem hiding this comment.
Could you please move the "(i.e." down to the beginning of the next line?
Done, it's better now. Well spotted.
Where possible and where it does not pose readability problem.
handrews
approved these changes
Apr 20, 2017
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.
As mentioned in #206 (comment), to hopefully make future review easier.
I choose 100 columns as a compromise because wrapping to 80 columns would lead to narrow blocks of text for deeply nested elements.
I could not find a tool to automate this that gives satisfactory results so I did that by hand. I occasionally left some text exceed the limit when it looked better not wrapped (e.g. to avoid breaking links).
git diff --word-diff mastercan be used to get a relevant diff.