Merge pull request #728 from zephyr-dev/patch-1

Add docs for id_param option of load_resource
ryanb · Feb 22, 2013 · ff2b632 · Sija · Mar 12, 2013 · ff2b632
2 parents ba82241 + 9f7f520
commit ff2b632
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/cancan/controller_additions.rb b/lib/cancan/controller_additions.rb
@@ -96,6 +96,11 @@ def load_and_authorize_resource(*args)
       #
       #     load_resource :find_by => :permalink # will use find_by_permalink!(params[:id])
       #
+      # [:+id_param+]
+      #   Find using a param key other than :id. For example:
+      #
+      #     load_resource :id_key => :url # will use find(params[:url])
+      #
       # [:+collection+]
       #   Specify which actions are resource collection actions in addition to :+index+. This
       #   is usually not necessary because it will try to guess depending on if the id param is present.