Merge pull request #2541 from code-mancers/add-definition-docs

Add some documentation about definition class

1 files changed, 5 insertions, 0 deletions

diff --git a/lib/bundler.rb b/lib/bundler.rb
index cb81c114..ea5673a3 100644
--- a/lib/bundler.rb
+++ b/lib/bundler.rb
@@ -137,6 +137,11 @@ module Bundler
       Bundler::Environment.new(root, definition)
     end
 
+    # Returns an instance of Bundler::Definition for given Gemfile and lockfile
+    #
+    # @param unlock [Hash, Boolean, nil] Gems that have been requested
+    #   to be updated or true if all gems should be updated
+    # @return [Bundler::Definition]
     def definition(unlock = nil)
       @definition = nil if unlock
       @definition ||= begin