Improve description of configuration in README.md. #540
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
This is for rubocop#536, but we may want to keep the issue open for discussion a while longer. Move the sentence about what the configuration file is for, to the first paragraph. Make the example .rubocop.yml file more realistic by setting parameter values that are different from the default ones. Clarify the note about AllCops/Excludes. Make first paragraph under "Including/Excluding files" more clear and simple. Make "Inheritance" a subchapter, and try to use the word "inherit" rather than "include" when describing inherit_from. Replace the word folder with directory so we use the same nomenclature throughout the README. Make "Disabling Cops within Source Code" its own subchapter, not under "Configuration", since it has nothing to do with .rubocop.yml.
bbatsov
added a commit
that referenced
this pull request
Oct 5, 2013
Improve description of configuration in README.md.
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.
This is for #536, but we may want to keep the issue open for discussion a while longer.
Move the sentence about what the configuration file is for, to the first paragraph.
Make the example
.rubocop.ymlfile more realistic by setting parameter values that are different from the default ones.Clarify the note about
AllCops/Excludes.Make first paragraph under "Including/Excluding files" more clear and simple.
Make "Inheritance" a subchapter, and try to use the word "inherit" rather than "include" when describing
inherit_from.Replace the word folder with directory so we use the same nomenclature throughout the README.
Make "Disabling Cops within Source Code" its own chapter, not under "Configuration", since it has nothing to do with
.rubocop.yml.