Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Provide MRI Core documentation and source code for the Pry REPL
Ruby C
Branch: master
Pull request Compare This branch is 118 commits ahead of banister:master.

README.md

Pry Doc

Description

Pry Doc is a plugin for Pry. It provides extended documentation support for Pry.

Installation

All you need is to install the gem. The pry-doc plugin will be detected and used automatically.

gem install pry-doc

Synopsis

Pry Doc extends two core Pry commands: show-doc and show-source (aliased as ? and $ respectively).

For example, in vanilla Pry it’s impossible to get the documentation for the loop method (it’s a method, by the way). However, Pry Doc solves that problem.

show-source

Let's check the source code of the loop method.

show-doc

Generally speaking, you can retrieve most of the MRI documentation and accompanying source code. Pry Doc is also smart enough to get any documentation for methods and classes implemented in C.

Limitations

Pry Doc supports the following Rubies:

  • MRI 1.9
  • MRI 2.0
  • MRI 2.1
  • MRI 2.2

Getting Help

Simply file an issue or visit #pry at irc.freenode.net.

License

The project uses the MIT Licencse. See LICENSE file for more information.

Something went wrong with that request. Please try again.