Improve headers in readme.md
#967
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
|
👍 |
|
Conflict |
|
Fixed. |
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
readme.mdheaders can be confusing. I often scroll up and down not knowing in which section I am.I think one of the issues is that we re-use the same words for some options, subprocess properties and result properties. In general, that's a good thing, but it creates confusion in the
readme.md. For example, we are using 3 times the "all" header: for the option, the stream, and the result property.This PR fixes this by prefixing those headers. For example,
options.all,subprocess.all,result.allanderror.all. This makes it clearer which section the user is currently reading.