mirror of
https://github.com/varvet/pundit.git
synced 2022-11-09 12:30:11 -05:00
Document the new error on methods
This commit is contained in:
parent
8fc620159f
commit
bae8278202
1 changed files with 4 additions and 0 deletions
|
@ -78,6 +78,7 @@ module Pundit
|
|||
# @see https://github.com/elabs/pundit#scopes
|
||||
# @param user [Object] the user that initiated the action
|
||||
# @param scope [Object] the object we're retrieving the policy scope for
|
||||
# @raise [InvalidConstructorError] if the policy constructor called incorrectly
|
||||
# @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope
|
||||
def policy_scope(user, scope)
|
||||
policy_scope = PolicyFinder.new(scope).scope
|
||||
|
@ -92,6 +93,7 @@ module Pundit
|
|||
# @param user [Object] the user that initiated the action
|
||||
# @param scope [Object] the object we're retrieving the policy scope for
|
||||
# @raise [NotDefinedError] if the policy scope cannot be found
|
||||
# @raise [InvalidConstructorError] if the policy constructor called incorrectly
|
||||
# @return [Scope{#resolve}] instance of scope class which can resolve to a scope
|
||||
def policy_scope!(user, scope)
|
||||
policy_scope = PolicyFinder.new(scope).scope!
|
||||
|
@ -105,6 +107,7 @@ module Pundit
|
|||
# @see https://github.com/elabs/pundit#policies
|
||||
# @param user [Object] the user that initiated the action
|
||||
# @param record [Object] the object we're retrieving the policy for
|
||||
# @raise [InvalidConstructorError] if the policy constructor called incorrectly
|
||||
# @return [Object, nil] instance of policy class with query methods
|
||||
def policy(user, record)
|
||||
policy = PolicyFinder.new(record).policy
|
||||
|
@ -119,6 +122,7 @@ module Pundit
|
|||
# @param user [Object] the user that initiated the action
|
||||
# @param record [Object] the object we're retrieving the policy for
|
||||
# @raise [NotDefinedError] if the policy cannot be found
|
||||
# @raise [InvalidConstructorError] if the policy constructor called incorrectly
|
||||
# @return [Object] instance of policy class with query methods
|
||||
def policy!(user, record)
|
||||
policy = PolicyFinder.new(record).policy!
|
||||
|
|
Loading…
Reference in a new issue