lululau / pry-doc Goto Github PK

• Repository: https://github.com/pry/pry-doc
• Wiki: https://github.com/pry/pry-doc/wiki
• 

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

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

gem install pry-doc

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.

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

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.

Pry Doc supports Ruby 1.9 and above.

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

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