Add documentation for id_param to authorize_resource (#836)

0llirocks · web-flow · commit a47f98945959 · 2024-05-23T17:07:18.000+02:00
Currently the id_param is not documented for authorize_resource. This commit adds the documentation.
diff --git a/lib/cancan/controller_additions.rb b/lib/cancan/controller_additions.rb
@@ -171,6 +171,11 @@ def load_resource(*args)
       # [:+instance_name+]
       #   The name of the instance variable for this resource.
       #
+      # [:+id_param+]
+      #   Find using a param key other than :id. For example:
+      #
+      #     load_resource :id_param => :url # will use find(params[:url])
+      #
       # [:+through+]
       #   Authorize conditions on this parent resource when instance isn't available.
       #

Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,11 @@ def load_resource(*args)`
`171`	`171`	`# [:+instance_name+]`
`172`	`172`	`# The name of the instance variable for this resource.`
`173`	`173`	`#`
	`174`	`+ # [:+id_param+]`
	`175`	`+ # Find using a param key other than :id. For example:`
	`176`	`+ #`
	`177`	`+ # load_resource :id_param => :url # will use find(params[:url])`
	`178`	`+ #`
`174`	`179`	`# [:+through+]`
`175`	`180`	`# Authorize conditions on this parent resource when instance isn't available.`
`176`	`181`	`#`