Project

pry-doc

1.13
Low commit activity in last 3 years
There's a lot of open issues
A long-lived project that still receives updates
Pry Doc is a Pry REPL plugin. It provides extended documentation support for the REPL by means of improving the `show-doc` and `show-source` commands. With help of the plugin the commands are be able to display the source code and the docs of Ruby methods and classes implemented in C. documentation
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 10.0
~> 3.5

Runtime

~> 0.11
~> 0.9.11
 Project Readme

Pry Doc

Circle Build Status

Description

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

Installation

Install the gem using the below command.

gem install pry-doc

To automatically load pry-doc upon starting pry, add the command require 'pry-doc' to your pryrc. You can read more about it in Pry's README file.

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 Ruby 2.0 and above.

Getting Help

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

License

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