README: normalize indentation of verbatim blocks#61
Open
waldyrious wants to merge 1 commit intoFiloSottile:mainfrom
Open
README: normalize indentation of verbatim blocks#61waldyrious wants to merge 1 commit intoFiloSottile:mainfrom
waldyrious wants to merge 1 commit intoFiloSottile:mainfrom
Conversation
Author
|
Note: There a couple additional minor changes that would benefit a markdown-style rendering of the text even, without adding the One is adding brackets to link labels: - foobar (https://example.com)
+[foobar](https://example.com)...but I feared that doing so might be going too far if the intent is to make the file readable primarily in plaintext mode. The second one is using backticks around variables, commands and file paths. I do believe this might be a subtle enough change (which would also allow sentences to be read more naturally even in plaintext mode) to be seriously considered. If that would be acceptable, I'd be happy to add the changes to this PR. |
This file contains hidden or 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.
While I am aware that there has been an explicit choice not to make the README strictly formatted as markdown (#22), the current content is already effectively markdown-compatible (the headings and the code/verbatim/preformatted blocks, in particular).
Since the existing preformatted blocks already use 4-spaces indentation (which is what makes them markdown-ready), it seems appropriate to also apply the same indentation to the last such block in the file.