fix render description for alias instance methods #2361
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.
I've noticed that descriptions for alias instance methods are not rendered. For example:
String#size
String#next
String#to_sym
Kernel#fail
Kernel#format
...and many other alias methods.
This issue comes from the following condition in the methods partial:
Because of this, if a method is an alias, its own description is skipped even when the API data actually contains documentation for that alias.
This PR updates the rendering logic so that alias methods can also display their descriptions (when present).
Edit:
After opening the PR, I noticed that this behavior differs depending on the documentation source.
For example, ruby-doc.org includes the description for alias methods, while docs.ruby-lang.org does not show the description for aliases. This suggests it may be a deliberate design choice upstream?
However, showing the description on alias methods could still provide a more complete and helpful documentation experience?