New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify description of owner-flags #5497
Clarify description of owner-flags #5497
Conversation
Thanks for opening a pull request and helping make RubyGems and Bundler better! Someone from the RubyGems team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality. We use GitHub Actions to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of GitHub Actions in the PR status window below. If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #rubygems or #bundler channel on Slack. For more information about contributing to the RubyGems project feel free to review our CONTRIBUTING guide |
Hello. Well spotted. This really depends on implementation of gemserver. RubyGems.org is friendly enough to support both handle and email (since this method is used -> https://github.com/rubygems/rubygems.org/blob/a4634ee7626e837f9b776f966c8b97b55f72ec8b/app/models/user.rb#L80). That's probably the reason for having so general description in there. Would it be possible to rewrite it to mention you need to specifiy user identifier and also mention RubyGems.org supports handle and email? |
I found the naming "email" a bit misleading, though I understand now that this comes from the API.
I generalized the description a bit more and added a note about the specific handling in the push server "rubygems.org". |
Oh noez! Timeout with this check:
Is there anything I can do? |
@simi Does this address your concerns? It seems like it does, so I plan to merge it. |
Awesome, thanks @kronn! |
Clarify description of owner-flags (cherry picked from commit 8264efd)
What was the end-user or developer problem that led to this PR?
I wanted to add a coworker as owner to a gem and was confused by the help-output. In the end, I tried to add the new owner by rubygems-handle and it worked. The docs and description only mention using an e-mail address.
I remember that other experienced developers also confused that and were asking for e-mails when the handle would have been sufficient.
What is your fix for the problem, implemented in this PR?
I changed the help-output to clarify what is accepted as argument to the respective flags. I did not write tests because the behavior has not been changed.
Make sure the following tasks are checked