[DOC] Change to handling of aliases #7340
Merged
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
BurdetteLamar
changed the title
jeremyevans
requested changes
Feb 19, 2023
| @@ -328,7 +327,7 @@ Return types: | |||
|
|
|||
| Aliases: | |||
|
|
|||
| - Omit aliases from the `call-seq`, but mention them near the end (see below). | |||
| - Omit aliases from the `call-seq`. | |||
There was a problem hiding this comment.
I would clarify that in rare circumstances aliases can be listed in the call-seq. @zverok provided an example for String#-@ and String#dedup. In this case (operator and normal method are aliases), it probably makes sense to list both. In this case, the operator and method can both be listed.
There was a problem hiding this comment.
I'm not sure how to characterize the exceptional cases. Would you please add something to the doc?
jeremyevans
approved these changes
Feb 19, 2023
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.
RDoc now automatically mentions aliases, so no need to mention explicitly.