From: kashyap.kmbc@gmail.com
To: ruby-core@ruby-lang.org
Subject: [ruby-core:74494] [Ruby trunk Feature#12208] Improve ri command
Date: Wed, 23 Mar 2016 06:31:36 +0000 [thread overview]
Message-ID: <redmine.journal-57616.20160323063136.0619ae1d9007f7d3@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-12208.20160323052246@ruby-lang.org
Issue #12208 has been updated by Kashyap K.
File Sample ri.png added
We could add the `ri` commands for each method on the Ruby [doc HTML pages](http://ruby-doc.org/core-2.3.0/) at just under the method signature line (like shown in the image attached) or some place else. That way anyone who visits the Ruby doc website will come to know the `ri` tool in general. And they might end up using it next time onwards. One more side-effect of this is that the difference between the 'dot' and 'pound' style usage (`String#to_s` and `Kernel.eval`) may become clear for people new to the language.
----------------------------------------
Feature #12208: Improve ri command
https://bugs.ruby-lang.org/issues/12208#change-57616
* 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/
next prev parent reply other threads:[~2016-03-23 5:55 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 ` kashyap.kmbc [this message]
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 ` [ruby-core:74589] " sto.mar
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-57616.20160323063136.0619ae1d9007f7d3@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).