- Repository: https://github.com/pry/pry-doc
- Wiki: https://github.com/pry/pry-doc/wiki
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.
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.
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.