Show aliases in specification reference #370
Merged
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.
Fixes rubygems/rubygems#7790.
Problem
add_dependency
is not documented in the specification reference, but it is documented in the rubydoc documentation. Since the specification is generated from theGem::Specification
class, similarly to rubydoc, I think the specification should also mentionadd_dependency
as an alias.Solution
Change the documentation template to show aliases in the specification reference like so:
FYI there is currently only one alias, which is
add_dependency
.Alternative solution
I mentioned in rubygems/rubygems#7790 that
add_dependency
seems to be more prominent, so alternatively we could show it more prominently in the reference by making it have its own entry as done in my other branch here, where the end result would look like this. I can update the PR if this way is preferred.