From 0fa64814b10c8b25b1f777e44505634d5fb82cbb Mon Sep 17 00:00:00 2001
From: John Mair <jrmair@gmail.com>
Date: Mon, 16 May 2011 04:19:13 +1200
Subject: [PATCH] documentation for plugins.rb

---
 lib/pry/plugins.rb | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lib/pry/plugins.rb b/lib/pry/plugins.rb
index f81cb3bf..01e0f0df 100644
--- a/lib/pry/plugins.rb
+++ b/lib/pry/plugins.rb
@@ -9,6 +9,7 @@ class Pry
         @name, @gem_name, @enabled = name, gem_name, enabled
       end
 
+      # Disable a plugin.
       def disable!
         self.enabled = false
       end
@@ -19,14 +20,18 @@ class Pry
       @plugins = []
     end
 
+    # Find all installed Pry plugins and store them in an internal array.
     def locate_plugins
       Gem.source_index.find_name('').each do |gem|
         next if gem.name !~ PRY_PLUGIN_PREFIX
         plugin_name = gem.name.split('-', 2).last
         @plugins << Plugin.new(plugin_name, gem.name, true)
       end
+      @plugins
     end
 
+    # @return [Hash] A hash with all plugin names (minus the 'pry-') as
+    #   keys and Plugin objects as values.
     def plugins
       h = {}
       @plugins.each do |plugin|
@@ -35,6 +40,7 @@ class Pry
       h
     end
 
+    # Require all enabled plugins, disabled plugins are skipped.
     def load_plugins
       @plugins.each do |plugin|
         require plugin.gem_name if plugin.enabled?