Move rubocop:disable comments out of documentation
#299
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
When `rubocop:disable` is used immediately above a method or module declaration, it becomes part of the documentation. Instead, if we inline it with the declaration itself, it is not included in the documentation. As a side benefit, RuboCop attaches it to that declaration only, removing the need to `rubocop:enable` afterwards. However, YARD applies it as documentation to whatever immediately follows, so if the next declaration is public, we must explicitly document it, so YARD properly ignores the `rubocop:disable` comment.
sambostock
commented
Jun 20, 2024
| # rubocop:disable Metrics/ClassLength | ||
| class SequenceSubcompiler < Subcompiler | ||
| class SequenceSubcompiler < Subcompiler # rubocop:disable Metrics/ClassLength | ||
| # Shift of 1 from standard Ruby indices |
There was a problem hiding this comment.
Inferred from a comment later in this file.
Comment on lines
+29
to
+31
| # Yields for each branch of the given union, forbidding unification of | ||
| # bindings which only appear in a subset of the union. | ||
| def union_bind(enum) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize |
There was a problem hiding this comment.
I'm not familiar with this section of the code base and what this method is actually meant to do, so I'm not sure this comment is accurate.
|
Thank you. |
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.
When
rubocop:disableis used immediately above a method or module declaration, it becomes part of the documentation.e.g.
Node#value_used?Instead, if we inline it with the declaration itself, it is not included in the documentation. As a side benefit, RuboCop attaches it to that declaration only, removing the need to
rubocop:enableafterwards.However, YARD applies it as documentation to whatever immediately follows, so if the next declaration is public, we must explicitly document it, so YARD properly ignores the
rubocop:disablecomment.