Show aliases in specification reference#370
Merged
deivid-rodriguez merged 1 commit intorubygems:mainfrom Jun 26, 2024
Merged
Conversation
deivid-rodriguez
approved these changes
Jun 25, 2024
Contributor
deivid-rodriguez
left a comment
There was a problem hiding this comment.
Not totally sure about which one of your proposals is best, but both improve the current situation. I'd say let's at least add this and we can discuss adding a separate entry for aliases too, or even inverting this and calling add_runtime_dependency an alias of add_dependency, or using add_runtime_dependency in bundle gem generated template.
Contributor
Author
|
All good points @deivid-rodriguez, where do you recommend discussing this? |
Contributor
|
Let me merge this, and we can open a new issue in this repo, referencing this PR? |
Contributor
Author
|
As I'm writing the issue, it looks like it is becoming more general and not just about the guides, so if you don't mind I'm going to create it in the rubygems/rubygems repo |
This file contains hidden or 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
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.
Fixes ruby/rubygems#7790.
Problem
add_dependencyis not documented in the specification reference, but it is documented in the rubydoc documentation. Since the specification is generated from theGem::Specificationclass, similarly to rubydoc, I think the specification should also mentionadd_dependencyas 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 ruby/rubygems#7790 that
add_dependencyseems 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.