Remove unnecessary coupling in comments' call_seq extraction #1289
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
There is no need to pass the method object to RDoc::Comment#extract_call_seq just to assign the result to the method object's call_seq attribute. This unnecessarily complicates the code and makes it harder to understand/refactor, which is evident in the method's tests. This commit removes the indirection and simplifies the implementation & tests.
st0012
changed the title
kou
approved these changes
Feb 10, 2025
Comment on lines
-113
to
115
| return if call_seq.empty? | ||
| return if call_seq.nil? || call_seq.empty? | ||
|
|
||
| @call_seq = call_seq |
There was a problem hiding this comment.
It's not related to this PR but we may want to set @call_seq even when call_seq is nil or "":
call_seq = nil if call_seq&.empty?
@call_seq = call_seqThere was a problem hiding this comment.
I thought about it but it's potentially risky if RDoc relies on this to avoid erasing the current value. Will need to do some testing to make sure it's ok to drop it.
vinistock
reviewed
Feb 10, 2025
vinistock
approved these changes
Feb 10, 2025
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.
There is no need to pass the method object to
RDoc::Comment#extract_call_seqjust to assign the result to the method object'scall_seqattribute. This unnecessarily complicates the code and makes it harder to understand/refactor, which is evident in the method's tests.This commit removes the indirection and simplifies the implementation & tests.