summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author0xAB <0xAB@protonmail.com>2017-08-31 12:14:49 +0100
committer0xAB <0xAB@protonmail.com>2017-08-31 12:14:49 +0100
commit133a50da88ba0d9a16ef90778a21491bbee460ec (patch)
treec8b6afa8c8c968ba6ab6b4301310b9dd3e03edfc
parent7e4d4a8b1fb51cf54630fe5b61a0c34cf0376d9d (diff)
downloadpry-133a50da88ba0d9a16ef90778a21491bbee460ec.tar.gz
improve docs [ci skip]pry-helpers
-rw-r--r--lib/pry/pry_instance.rb9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/pry/pry_instance.rb b/lib/pry/pry_instance.rb
index 949171fd..c4664505 100644
--- a/lib/pry/pry_instance.rb
+++ b/lib/pry/pry_instance.rb
@@ -82,8 +82,15 @@ class Pry
end
#
+ # @example
+ #
+ # Pry.hooks.add_hook(:before_session, "hook_name") do |_, _, pry|
+ # puts pry.helpers.green("Starting new session.")
+ # end
+ #
# @return [Module]
- # Returns a module that includes basic utility helper functions.
+ # Returns a module that includes utility helper functions from
+ # {Pry::Helpers::Text}, and {Pry::Helpers::BaseHelpers}.
#
def helpers
@helpers ||= lambda {