[rubocop#3246] Enhance cops documentation with navigation and better …

…layout
renuo · Oct 17, 2016 · 0a0035c · 0a0035c
1 parent d516771
commit 0a0035c
Show file tree

Hide file tree

Showing 11 changed files with 912 additions and 892 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,6 +5,7 @@ The more detailed you are, the better.**
 
 Before submitting the PR make sure the following are checked:
 
+* [ ] Documentation updated with `rake generate_cops_documentation`
 * [ ] Wrote [good commit messages][1].
 * [ ] Commit message starts with `[Fix #issue-number]` (if the related issue exists).
 * [ ] Used the same coding conventions as the rest of the project.

diff --git a/manual/cops.md b/manual/cops.md
diff --git a/manual/cops_lint.md b/manual/cops_lint.md
@@ -54,9 +54,9 @@ if/while/until.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-AllowSafeAssignment | true| |
+Attribute | Value
+--- | ---
+AllowSafeAssignment | true
 
 
 ## Lint/BlockAlignment
@@ -103,10 +103,10 @@ end
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-AlignWith | either| |
-SupportedStyles | either, start_of_block, start_of_line| |
+Attribute | Value
+--- | ---
+AlignWith | either
+SupportedStyles | either, start_of_block, start_of_line
 
 
 ## Lint/CircularArgumentReference
@@ -199,11 +199,11 @@ end
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-AlignWith | start_of_line| |
-SupportedStyles | start_of_line, def| |
-AutoCorrect | false| |
+Attribute | Value
+--- | ---
+AlignWith | start_of_line
+SupportedStyles | start_of_line, def
+AutoCorrect | false
 
 
 ## Lint/DeprecatedClassMethods
@@ -351,11 +351,11 @@ end)
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-AlignWith | keyword| |
-SupportedStyles | keyword, variable, start_of_line| |
-AutoCorrect | false| |
+Attribute | Value
+--- | ---
+AlignWith | keyword
+SupportedStyles | keyword, variable, start_of_line
+AutoCorrect | false
 
 
 ## Lint/EndInMethod
@@ -528,10 +528,10 @@ class C < StandardError; end
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-EnforcedStyle | runtime_error| |
-SupportedStyles | runtime_error, standard_error| |
+Attribute | Value
+--- | ---
+EnforcedStyle | runtime_error
+SupportedStyles | runtime_error, standard_error
 
 
 ## Lint/InvalidCharacterLiteral
@@ -984,10 +984,10 @@ end
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-IgnoreEmptyBlocks | true| |
-AllowUnusedKeywordArguments | false| |
+Attribute | Value
+--- | ---
+IgnoreEmptyBlocks | true
+AllowUnusedKeywordArguments | false
 
 
 ## Lint/UnusedMethodArgument
@@ -1008,10 +1008,10 @@ end
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-AllowUnusedKeywordArguments | false| |
-IgnoreEmptyMethods | true| |
+Attribute | Value
+--- | ---
+AllowUnusedKeywordArguments | false
+IgnoreEmptyMethods | true
 
 
 ## Lint/UselessAccessModifier
@@ -1099,9 +1099,9 @@ end
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-ContextCreatingMethods | | |
+Attribute | Value
+--- | ---
+ContextCreatingMethods | 
 
 
 ## Lint/UselessAssignment

diff --git a/manual/cops_metrics.md b/manual/cops_metrics.md
@@ -12,10 +12,10 @@ configured maximum. The ABC size is based on assignments, branches
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-Reference | http://c2.com/cgi/wiki?AbcMetric| |
-Max | 19| |
+Attribute | Value
+--- | ---
+Reference | http://c2.com/cgi/wiki?AbcMetric
+Max | 19
 
 
 ## Metrics/BlockLength
@@ -30,11 +30,11 @@ The maximum allowed length is configurable.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-CountComments | false| |
-Max | 25| |
-Exclude | /Rakefile, /**/*.rake, /spec/**/*.rb| |
+Attribute | Value
+--- | ---
+CountComments | false
+Max | 25
+Exclude | Rakefile, \*\*/\*.rake, spec/\*\*/\*.rb
 
 
 ## Metrics/BlockNesting
@@ -51,9 +51,9 @@ The maximum level of nesting allowed is configurable.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-Max | 3| |
+Attribute | Value
+--- | ---
+Max | 3
 
 
 ## Metrics/ClassLength
@@ -68,10 +68,10 @@ The maximum allowed length is configurable.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-CountComments | false| |
-Max | 168| |
+Attribute | Value
+--- | ---
+CountComments | false
+Max | 168
 
 
 ## Metrics/CyclomaticComplexity
@@ -93,9 +93,9 @@ Loops can be said to have an exit condition, so they add one.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-Max | 7| |
+Attribute | Value
+--- | ---
+Max | 7
 
 
 ## Metrics/LineLength
@@ -109,13 +109,13 @@ The maximum length is configurable.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-Max | 80| |
-AllowHeredoc | true| |
-AllowURI | true| |
-URISchemes | http, https| |
-IgnoreCopDirectives | false| |
+Attribute | Value
+--- | ---
+Max | 80
+AllowHeredoc | true
+AllowURI | true
+URISchemes | http, https
+IgnoreCopDirectives | false
 
 
 ## Metrics/MethodLength
@@ -130,10 +130,10 @@ The maximum allowed length is configurable.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-CountComments | false| |
-Max | 14| |
+Attribute | Value
+--- | ---
+CountComments | false
+Max | 14
 
 
 ## Metrics/ModuleLength
@@ -148,10 +148,10 @@ The maximum allowed length is configurable.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-CountComments | false| |
-Max | 156| |
+Attribute | Value
+--- | ---
+CountComments | false
+Max | 156
 
 
 ## Metrics/ParameterLists
@@ -167,10 +167,10 @@ be excluded from the total count.
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-Max | 5| |
-CountKeywordArgs | true| |
+Attribute | Value
+--- | ---
+Max | 5
+CountKeywordArgs | true
 
 
 ## Metrics/PerceivedComplexity
@@ -207,7 +207,7 @@ end                             # 7 complexity points
 
 ### Important attributes
 
-Attribute | Value |
---- | --- |
-Max | 7| |
+Attribute | Value
+--- | ---
+Max | 7