Project

General

Profile

Bug #15359

Bundler help is not properly integrated

Added by vo.x (Vit Ondruch) 10 months ago. Updated 10 months ago.

Status:
Assigned
Priority:
Normal
Target version:
-
ruby -v:
ruby 2.6.0dev (2018-11-26 trunk 65990) [x86_64-linux]
[ruby-core:90164]

Description

Bundler has nice help, but it is a bit complex 1. It ideally needs man command installed but it definitely needs the help source files, which are not placed on proper location to be reachable by BUndler from StdLib. In that case, Bundler fallbacks to the simplest help provided by its Thor based CLI, but that is probably not the user experience integrated Bundler should provide.

For comparison, this is the official help:

 bundler --help
BUNDLE(1)                                BUNDLE(1)



NAME
       bundle - Ruby Dependency Management

... snip ...

OBSOLETE
       These commands are obsolete and should no longer be used

       o   bundle cache(1)

       o   bundle show(1)






                   July 2017                 BUNDLE(1)

and this is the help output provided by the bundled Bundler:

# bundler --help
Bundler commands:
  bundler add GEM VERSION         # Add gem to Gemfile and run bundle install

... snip ...

  bundler version                 # Prints the bundler's version information

Options:
      [--no-color]                 # Disable colorization in output
  -r, [--retry=NUM]                # Specify the number of times you wish to attempt network commands
  -V, [--verbose], [--no-verbose]  # Enable verbose output mode

History

#1

Updated by vo.x (Vit Ondruch) 10 months ago

BTW I am not sure how the Bundler man pages are imported into Ruby repository, but I think there should be either the source .ronn files or the resulting .txt files and man page files. Not both.

Updated by shevegen (Robert A. Heiler) 10 months ago

I can't comment on the issue itself but I wanted to add that I personally do not
use man-pages. I use the commandline "--help" flag, though, and of course online
queries for help (and then I often put useful bits into a local knowledgebase; I
did so for ruby as well).

Of course others may benefit from man-pages still, but I think that "--help"
is probably the number one way for many ruby users, especially linux users,
for quick help; whereas "man bundler" would be significantly less commonly
used, I'd assume.

The second result seems a lot more useful to me than the first one by the
way. I am not even sure it is very useful to tell users that things may
be obsolete ... :-)

#3

Updated by hsbt (Hiroshi SHIBATA) 10 months ago

  • Status changed from Open to Assigned

Also available in: Atom PDF