Limit line length to 80 & clean-up nearby formatting. #282
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
Wide-ranging but essentially trivial adjustment of line length. Also fixes top-level indenting in gdb.rst particularly.
ezio-melotti
reviewed
Oct 13, 2017
documenting.rst
Outdated
| @@ -456,7 +457,7 @@ the extension mechanisms of reST, and Sphinx makes heavy use of it. | |||
|
|
|||
| Basically, a directive consists of a name, arguments, options and content. (Keep | |||
| this terminology in mind, it is used in the next chapter describing custom | |||
| directives.) Looking at this example, :: | |||
| directives.) Looking at this example,:: | |||
There was a problem hiding this comment.
Isn't the space necessary here?
You could remove the comma and use example::, but otherwise I would leave it as is.
There was a problem hiding this comment.
That's a bit of Eclipse formatting (good for some things), not intentional. I see that in the original, the comma shows and the colon is invisible. I'll replace with the long form.
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.
Primary aim is to conform to the 80 character rule (where possible). At the same time I've cleaned up other formatting faults in the same area as the long lines.
I don't personally like to re-flow paragraphs further than end of the affected sentence when I'm writing, so I mostly haven't. It makes it easier to see what changed.