Fix broken doc style of Style/BracesAroundHashParameters cop
#4880
Conversation
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
|
Could you check yard doc also? We can the yard doc for this cop with |
koic
force-pushed
the
fix_broken_document_style_of_style_braces_around_hash_parameters
branch
from
6ca1306 to
1b6cefb
Compare
|
I was not checking with Before
After
This will result in a unified format. |
|
On the other hand, if it seems preferable not to use |
|
It seem it was a mistake on our part to be using examples for listing code and bad cases, or at least this is the impression I had from this PR. Not sure what exactly would be the best course of action in general. I'd certainly prefer us to be consistent about this. |
|
The documentation for |
|
And here we have the option of the @lsegal himself (yard's author) https://gitter.im/lsegal/yard?at=59e530ea32e080696eeb2e38 |
|
Thank you for the pointer to the information.
Example codes are described only in Explanations of 3 styles are redundant😓 , but it seems that description section and examples section role are separated. WDYT? |
|
This seems like a reasonable option as well 957d86d |
|
FYI, examples can have title lines in which you can summarize the purpose, instead of in comments. |
koic
force-pushed
the
fix_broken_document_style_of_style_braces_around_hash_parameters
branch
from
f524ff8 to
5c1720c
Compare
|
I appreciate your advice. First, I made the text of the explanation section simple. Next, I wrote the supported styles on the title line of
I could not replace all the explanation with the code comment because I did not understand the text wrapping of title line (The length exceeds 80) 💦 But these are summaries so it may be good as well. |
|
Looks great! I guess we should adopt this style consistently for cops with multiple supported styles. |
koic
deleted the
fix_broken_document_style_of_style_braces_around_hash_parameters
branch
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 1, 2017
Follow up of rubocop#4880 (comment). This commit is a change of document format. Because there are many cops to be changed, this commit applied a new style to some Layout department cops first.
11 tasks
bbatsov
pushed a commit
that referenced
this pull request
Nov 2, 2017
Follow up of #4880 (comment). This commit is a change of document format. Because there are many cops to be changed, this commit applied a new style to some Layout department cops first.
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 5, 2017
Follow up of rubocop#4880 (comment). This commit is a change of document format. Cops of `naming` department are the target. Since example of `Naming/HeredocDelimiterCase` cop was the opposite of `bad` and `good`, it was rearranged for unification. Also added `default` information based on `config/default.yml`.
11 tasks
bbatsov
pushed a commit
that referenced
this pull request
Nov 5, 2017
Follow up of #4880 (comment). This commit is a change of document format. Cops of `naming` department are the target. Since example of `Naming/HeredocDelimiterCase` cop was the opposite of `bad` and `good`, it was rearranged for unification. Also added `default` information based on `config/default.yml`.
11 tasks
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 6, 2017
Follow up of rubocop#4880 (comment). This commit applied a new style to some `Style` department cops, the same policy as rubocop#4978.
bbatsov
pushed a commit
that referenced
this pull request
Nov 7, 2017
Follow up of #4880 (comment). This commit applied a new style to some `Style` department cops, the same policy as #4978.
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 8, 2017
Follow up of rubocop#4880 (comment). This commit is a change of document format. Cops of `Lint` department are the target.
11 tasks
8 tasks
bbatsov
pushed a commit
that referenced
this pull request
Jun 9, 2018
Follow up of #4880 (comment) and #5699. This commit is a change of document format for `Layout/FirstParameterIndentation` cop. This PR uses `# rubocop:disable Metrics/LineLength` because line length of the following line exceeds 80. ```diff + # @example EnforcedStyle: special_for_inner_method_call_in_parentheses (default) ``` Descriptions of `EnforcedStyle` are quoted from default.yml. https://github.com/rubocop-hq/rubocop/blob/v0.57.1/config/default.yml#L365-L381
koic
added a commit
that referenced
this pull request
Sep 24, 2018
Follow up of #4880 (comment). This commit is a change of document format for `Rails/Delegate` cop.
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
Follow up of rubocop/rubocop#4880 (comment). This commit is a change of document format for `Rails/ActionFilter` cop.
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
Follow up of rubocop/rubocop#4880 (comment). This commit is a change of document format for `Rails/Date` cop.
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
Follow up of rubocop/rubocop#4880 (comment). This commit is a change of document format for `Rails/RequestReferer` cop.
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
Follow up of rubocop/rubocop#4880 (comment). This is only document change. This commit adds an example of `EnforcedStyle` to `Rails/TimeZone`.
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
Follow up of rubocop/rubocop#4880 (comment). This commit is a change of document format for `Rails/UniqBeforePluck` cop.
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
Follow up of rubocop/rubocop#4880 (comment). This commit is a change of document format for `Rails/Delegate` cop.
koic
added a commit
to koic/rubocop
that referenced
this pull request
Oct 2, 2019
Follow up of rubocop#4880 (comment). This PR is a change of document format for `Style/MethodCallWithArgsParentheses` cop.
8 tasks
bbatsov
pushed a commit
that referenced
this pull request
Oct 3, 2019
Follow up of #4880 (comment). This PR is a change of document format for `Style/MethodCallWithArgsParentheses` cop.
koic
added a commit
to koic/rubocop
that referenced
this pull request
Oct 3, 2019
Follow up of rubocop#4880 (comment). This PR is a change of document format for `Lint/Void` cop.
8 tasks
bbatsov
pushed a commit
that referenced
this pull request
Oct 3, 2019
Follow up of #4880 (comment). This PR is a change of document format for `Lint/Void` cop.
8 tasks
koic
added a commit
to koic/rubocop
that referenced
this pull request
Oct 26, 2019
Follow up of rubocop#4880 (comment). This PR is a change of document format for `Style/NonNilCheck` cop.
bbatsov
pushed a commit
that referenced
this pull request
Oct 27, 2019
Follow up of #4880 (comment). This PR is a change of document format for `Style/NonNilCheck` cop.
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 14, 2019
Follow up of rubocop#4880 (comment). This PR is a change of document format for `Style/NumericLiterals` cop.
8 tasks
bbatsov
pushed a commit
that referenced
this pull request
Nov 14, 2019
Follow up of #4880 (comment). This PR is a change of document format for `Style/NumericLiterals` cop.
koic
added a commit
to koic/rubocop
that referenced
this pull request
Aug 29, 2021
Follow up of rubocop#4880 (comment) This PR is a change of document format for `Style/CaseEquality` cop.
8 tasks
bbatsov
pushed a commit
that referenced
this pull request
Aug 29, 2021
Follow up of #4880 (comment) This PR is a change of document format for `Style/CaseEquality` cop.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 PR fixes the broken document style that
goodandbadare displayed in the sidebar.https://rubocop.readthedocs.io/en/latest/cops_style/#bad
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).rake spec) are passing.rake internal_investigation.and description in grammatically correct, complete sentences.
rake generate_cops_documentation(required only when you've added a new cop or changed the configuration/documentation of an existing cop).