From e2f817b4606a4dd5687452db1b806af6e9898b89 Mon Sep 17 00:00:00 2001 From: Yorick Peterse Date: Tue, 19 Jun 2012 17:08:59 +0200 Subject: [PATCH] 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 --- lib/pry/pry_instance.rb | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/lib/pry/pry_instance.rb b/lib/pry/pry_instance.rb index 84a82ec5..7f999f97 100644 --- a/lib/pry/pry_instance.rb +++ b/lib/pry/pry_instance.rb @@ -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