Expanded the documentation of "Pry" a bit.

Running `show-doc Pry` now shows a bit more useful information than just a
short description of what Pry is.

Signed-off-by: Yorick Peterse <yorickpeterse@gmail.com>
This commit is contained in:
Yorick Peterse 2012-06-19 17:08:59 +02:00
parent 203850c130
commit e2f817b460
1 changed files with 21 additions and 2 deletions

View File

@ -1,7 +1,26 @@
require "pry/indent"
# Pry is a powerful alternative to the standard IRB shell for Ruby.
# It features syntax highlighting, a flexible plugin architecture, runtime invocation and source and documentation browsing.
##
# Pry is a powerful alternative to the standard IRB shell for Ruby. It
# features syntax highlighting, a flexible plugin architecture, runtime
# invocation and source and documentation browsing.
#
# Pry can be started similar to other command line utilities by simply running
# the following command:
#
# pry
#
# Once inside Pry you can invoke the help message:
#
# help
#
# This will show a list of available commands and their usage. For more
# information about Pry you can refer to the following resources:
#
# * http://pry.github.com/
# * https://github.com/pry/pry
# * the IRC channel, which is #pry on the Freenode network
#
class Pry
attr_accessor :input