ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
From: sto.mar@web.de
To: ruby-core@ruby-lang.org
Subject: [ruby-core:74589] [Ruby trunk Feature#12208] Improve ri command
Date: Sat, 26 Mar 2016 14:07:10 +0000	[thread overview]
Message-ID: <redmine.journal-57718.20160326140710.7903e9fe4013e4b0@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-12208.20160323052246@ruby-lang.org

Issue #12208 has been updated by Marcus Stollsteimer.


I like and use ri. It's nice that it works offline but there _are_ some inconveniences; two of them that come to my mind right now:

* For common method names the output is rather confusing, implementations from core and stdlib and installed gems are listed without any logic order (at least to me).

* ri doesn't give the full namespace hierarchy of a given method, so it's not always easy to get more information on the class that defines a specific method. Example: `ri fetch` points to the `Row` class ("Implementation from Row"), but `ri Row` doesn't give any result (only `ri CSV::Row` does).

Regarding the suggestion of showing the ri command for every method in the HTML docs: for me that would produce too much noise.

----------------------------------------
Feature #12208: Improve ri command
https://bugs.ruby-lang.org/issues/12208#change-57718

* Author: Yui NARUSE
* Status: Open
* Priority: Normal
* Assignee: 
----------------------------------------
Ruby has well documented in rdoc.
It also has a frontend CLI.

But people seems not using `ri`...

At first, write your request here to improve ri command!

---Files--------------------------------
Sample ri.png (44.7 KB)


-- 
https://bugs.ruby-lang.org/

  parent reply	other threads:[~2016-03-26 13:30 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <redmine.issue-12208.20160323052246@ruby-lang.org>
2016-03-23  5:22 ` [ruby-core:74493] [Ruby trunk Feature#12208] Improve ri command naruse
2016-03-23  6:31 ` [ruby-core:74494] " kashyap.kmbc
2016-03-23 21:34 ` [ruby-core:74499] " shevegen
2016-03-24  2:20 ` [ruby-core:74503] " duerst
2016-03-24  3:05   ` [ruby-core:74504] " Austin Ziegler
2016-03-26 14:07 ` sto.mar [this message]
2019-01-13  8:37 ` [ruby-core:91063] " hsbt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.ruby-lang.org/en/community/mailing-lists/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=redmine.journal-57718.20160326140710.7903e9fe4013e4b0@ruby-lang.org \
    --to=ruby-core@ruby-lang.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).