https://github.com/tombenner/rh

Fast Ruby documentation lookup
https://github.com/tombenner/rh

ruby ruby-documentation

Last synced: about 2 months ago
JSON representation

Fast Ruby documentation lookup

• Host: GitHub
• URL: https://github.com/tombenner/rh
• Owner: tombenner
• License: mit
• Created: 2014-12-10T15:38:07.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-11T06:11:13.000Z (about 10 years ago)
• Last Synced: 2024-10-04T11:18:46.509Z (3 months ago)
• Topics: ruby, ruby-documentation
• Language: Ruby
• Size: 211 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
Rh

=====

Fast Ruby documentation lookup

[](http://travis-ci.org/tombenner/rh)

Overview

--------

Rh lets you easily look up Ruby documentation about classes, modules, and methods from the command line:

```bash

$ rh Array

$ rh Enumerable#chunk

$ rh Time.gm

$ rh with_index

```

If you're not sure where a method is defined, you can just enter it. If it's only defined in one class/module, that documentation will be shown. Otherwise, you'll get a choice:

```bash

$ rh cycle

Did you mean?

  0. Array#cycle

  1. Enumerable#cycle

Enter a number:

```

Everything from the core API and the standard library is supported, and documentation is shown on [ruby-doc.org](http://www.ruby-doc.org/) in a browser. Rh might eventually show documentation in the shell instead.

Rh shows documentation for the version of Ruby that's running it.

Installation

------------

```bash

gem install rh

```

Usage

-----

### Formats

#### Classes/modules:

```bash

$ rh Array

```

#### Class methods:

```bash

$ rh Time.gm

$ rh Time::gm

$ rh .gm

$ rh ::gm

```

#### Instance methods:

```bash

$ rh Enumerable#chunk

$ rh '#chunk'

```

#### Class methods and instance methods:

```bash

$ rh parse

```

License

-------

Rh is released under the MIT License. Please see the MIT-LICENSE file for details.