Skip to content

Commit

Permalink
reworded some sections in README and Customizing-pry.md to make confi…
Browse files Browse the repository at this point in the history
…gurability options clearer
  • Loading branch information
banister committed Jan 22, 2011
1 parent 09d1ace commit 9e78a80
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 11 additions & 3 deletions README.markdown
Expand Up @@ -6,11 +6,20 @@ Pry
_attach an irb-like session to any object at runtime_ _attach an irb-like session to any object at runtime_


Pry is a simple Ruby REPL (Read-Eval-Print-Loop) that specializes in the interactive Pry is a simple Ruby REPL (Read-Eval-Print-Loop) that specializes in the interactive
manipulation of objects during the running of a program. manipulation of objects during the running of a program.

In some sense it is the opposite of IRB in that you bring a REPL
session to your code (with Pry) instead of bringing your code to a
REPL session (as with IRB).


It is not based on the IRB codebase, and implements some unique REPL It is not based on the IRB codebase, and implements some unique REPL
commands such as `show_method` and `show_doc` commands such as `show_method` and `show_doc`


Pry is also fairly flexible and allows significant user
customization. It is trivial to set it to read from any
object that has a `readline` method and write to any object that has a
`puts` method - many other aspects of Pry are also configurable.

* Install the [gem](https://rubygems.org/gems/pry): `gem install pry` * Install the [gem](https://rubygems.org/gems/pry): `gem install pry`
* Read the [documentation](http://rdoc.info/github/banister/pry/master/file/README.markdown) * Read the [documentation](http://rdoc.info/github/banister/pry/master/file/README.markdown)
* See the [source code](http://github.com/banister/pry) * See the [source code](http://github.com/banister/pry)
Expand Down Expand Up @@ -263,8 +272,7 @@ features, see the `examples/` directory.
Customizing Pry Customizing Pry
--------------- ---------------


Pry supports customization of the input, the output, the commands, Pry allows a large degree of customization.
the hooks, the prompt, and 'print' (the "P" in REPL).


[Read how to customize Pry here.](http://rdoc.info/github/banister/pry/master/file/wiki/Customizing-pry.md) [Read how to customize Pry here.](http://rdoc.info/github/banister/pry/master/file/wiki/Customizing-pry.md)


Expand Down
2 changes: 1 addition & 1 deletion wiki/Customizing-pry.md
Expand Up @@ -2,7 +2,7 @@ Customizing Pry
--------------- ---------------


Pry supports customization of the input, the output, the commands, Pry supports customization of the input, the output, the commands,
the hooks, the prompt, and 'print' (the "P" in REPL). the hooks, the prompt, and the 'print' object (the "P" in REPL).


Global customization, which applies to all Pry sessions, is done Global customization, which applies to all Pry sessions, is done
through invoking class accessors on the `Pry` class, the accessors through invoking class accessors on the `Pry` class, the accessors
Expand Down

0 comments on commit 9e78a80

Please sign in to comment.