-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Simplify initial gem help output #3148
Merged
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
Yes, RubyGems is sophisticated, but that's not a helpful description. It is, without question, a package manager for Ruby. And no, we don't need to explain that argument-less command output is a basic help message with pointers, the pointers themselves can show that for us by being printed directly below. Before: ``` $ gem RubyGems is a sophisticated package manager for Ruby. This is a basic help message containing pointers to more information. Usage: gem -h/--help gem -v/--version gem command [arguments...] [options...] Examples: gem install rake gem list --local gem build package.gemspec gem help install Further help: gem help commands list all 'gem' commands gem help examples show some examples of usage gem help gem_dependencies gem dependencies file guide gem help platforms gem platforms guide gem help <COMMAND> show help on COMMAND (e.g. 'gem help install') gem server present a web page at http://localhost:8808/ with info about installed gems Further information: http://guides.rubygems.org ``` After: ``` $ gem RubyGems is a package manager for Ruby. Usage: gem -h/--help gem -v/--version gem command [arguments...] [options...] Examples: gem install rake gem list --local gem build package.gemspec gem help install Further help: gem help commands list all 'gem' commands gem help examples show some examples of usage gem help gem_dependencies gem dependencies file guide gem help platforms gem platforms guide gem help <COMMAND> show help on COMMAND (e.g. 'gem help install') gem server present a web page at http://localhost:8808/ with info about installed gems Further information: http://guides.rubygems.org ``` We save a line, and lose precious little.
deivid-rodriguez
approved these changes
Feb 21, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Much better, I concur! 💜
bronzdoc
approved these changes
Feb 21, 2020
@bundlerbot merge |
ghost
pushed a commit
that referenced
this pull request
Feb 21, 2020
3148: Simplify initial gem help output r=bronzdoc a=olivierlacan Yes, RubyGems is sophisticated, but that's not a helpful description. It is, without question, a package manager for Ruby. And no, we don't need to explain that argument-less command output is a basic help message with pointers, the pointers themselves can show that for us by being printed directly below. Before: ``` $ gem RubyGems is a sophisticated package manager for Ruby. This is a basic help message containing pointers to more information. Usage: gem -h/--help gem -v/--version gem command [arguments...] [options...] Examples: gem install rake gem list --local gem build package.gemspec gem help install Further help: gem help commands list all 'gem' commands gem help examples show some examples of usage gem help gem_dependencies gem dependencies file guide gem help platforms gem platforms guide gem help <COMMAND> show help on COMMAND (e.g. 'gem help install') gem server present a web page at http://localhost:8808/ with info about installed gems Further information: http://guides.rubygems.org ``` After: ``` $ gem RubyGems is a package manager for Ruby. Usage: gem -h/--help gem -v/--version gem command [arguments...] [options...] Examples: gem install rake gem list --local gem build package.gemspec gem help install Further help: gem help commands list all 'gem' commands gem help examples show some examples of usage gem help gem_dependencies gem dependencies file guide gem help platforms gem platforms guide gem help <COMMAND> show help on COMMAND (e.g. 'gem help install') gem server present a web page at http://localhost:8808/ with info about installed gems Further information: http://guides.rubygems.org ``` We save a line, and lose precious little. Co-authored-by: Olivier Lacan <hi@olivierlacan.com>
Timed out |
@bundlerbot retry |
ghost
pushed a commit
that referenced
this pull request
Feb 21, 2020
3147: Clarify gem install --bindir purpose r=bronzdoc a=olivierlacan The sentence "Directory where executables are located" suggests that "executables" are already "located" (prior to running the command) there. I know this is obvious from the perspective of implementors but this is confusing, especially from the perspective of someone who doesn't realize there is a difference between a gem and its binary executable. This propose alternative suggest by the use of the future tense that this is a prospective binary executable installation path and not a present one: > Directory where executables will be placed when the gem is installed 3148: Simplify initial gem help output r=bronzdoc a=olivierlacan Yes, RubyGems is sophisticated, but that's not a helpful description. It is, without question, a package manager for Ruby. And no, we don't need to explain that argument-less command output is a basic help message with pointers, the pointers themselves can show that for us by being printed directly below. Before: ``` $ gem RubyGems is a sophisticated package manager for Ruby. This is a basic help message containing pointers to more information. Usage: gem -h/--help gem -v/--version gem command [arguments...] [options...] Examples: gem install rake gem list --local gem build package.gemspec gem help install Further help: gem help commands list all 'gem' commands gem help examples show some examples of usage gem help gem_dependencies gem dependencies file guide gem help platforms gem platforms guide gem help <COMMAND> show help on COMMAND (e.g. 'gem help install') gem server present a web page at http://localhost:8808/ with info about installed gems Further information: http://guides.rubygems.org ``` After: ``` $ gem RubyGems is a package manager for Ruby. Usage: gem -h/--help gem -v/--version gem command [arguments...] [options...] Examples: gem install rake gem list --local gem build package.gemspec gem help install Further help: gem help commands list all 'gem' commands gem help examples show some examples of usage gem help gem_dependencies gem dependencies file guide gem help platforms gem platforms guide gem help <COMMAND> show help on COMMAND (e.g. 'gem help install') gem server present a web page at http://localhost:8808/ with info about installed gems Further information: http://guides.rubygems.org ``` We save a line, and lose precious little. Co-authored-by: Olivier Lacan <hi@olivierlacan.com>
Timed out (retrying...) |
Build succeeded
|
This pull request was closed.
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.
Yes, RubyGems is sophisticated, but that's not a helpful description. It is,
without question, a package manager for Ruby.
And no, we don't need to explain that argument-less command output is a basic
help message with pointers, the pointers themselves can show that for us by
being printed directly below.
Before:
After:
We save a line, and lose precious little.