diff options
| author | Kyrylo Silin <silin@kyrylo.org> | 2018-10-11 00:16:51 +0800 |
|---|---|---|
| committer | Kyrylo Silin <silin@kyrylo.org> | 2018-10-11 00:42:38 +0800 |
| commit | 4bee7e368dc74c953ba258ef84a9bbc344f4cda5 (patch) | |
| tree | 04508e62ef1e895e7cd957c09b167a02058ecef0 /README.md | |
| parent | d284dfbab85e8c64c1bcf75c7a0c314a6ef51b49 (diff) | |
| download | pry-4bee7e368dc74c953ba258ef84a9bbc344f4cda5.tar.gz | |
Tweak documentation for pryrc
Since `~/.pryrc` was replaced by `$XDG_CONFIG_HOME` and `~/.config/pry/pryrc` in
https://github.com/pry/pry/pull/1609, we need to adjust some
documentation. `~/.pryrc` becomes simply `pryrc`.
I've also edited the wiki with this similar change.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 7 insertions, 8 deletions
@@ -52,10 +52,10 @@ is trivial to set it to read from any object that has a `readline` method and wr `puts` method - many other aspects of Pry are also configurable making it a good choice for implementing custom shells. -Pry comes with an executable so it can be invoked at the command line. -Just enter `pry` to start. A `.pryrc` file in the user's home directory will -be loaded if it exists. Type `pry --help` at the command line for more -information. +Pry comes with an executable so it can be invoked at the command line. Just +enter `pry` to start. A `pryrc` file in `$XDG_CONFIG_HOME/pry/` or the user's +home directory will be loaded if it exists. Type `pry --help` at the command +line for more information. Try `gem install pry-doc` for additional documentation on Ruby Core methods. The additional docs are accessed through the `show-doc` and @@ -180,9 +180,8 @@ present working directory into the Pry prompt and bring in (limited at this stag We can also interpolate Ruby code directly into the shell by using the normal `#{}` string interpolation syntax. -In the code below we're going to switch to `shell-mode` and edit the -`.pryrc` file in the home directory. We'll then cat its contents and -reload the file. +In the code below we're going to switch to `shell-mode` and edit the `pryrc` +file. We'll then cat its contents and reload the file. pry(main)> shell-mode pry main:/home/john/ruby/projects/pry $ .cd ~ @@ -383,7 +382,7 @@ gem. You can toggle the syntax highlighting on and off in a session by using the `toggle-color` command. Alternatively, you can turn it off -permanently by putting the line `Pry.color = false` in your `~/.pryrc` +permanently by putting the line `Pry.color = false` in your `pryrc` file. ### Future Directions |