lib/trust/actor.rb in trust-0.7.0 vs lib/trust/actor.rb in trust-0.8.0
- old
+ new
@@ -23,10 +23,16 @@
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module Trust
# = Trust::Actor extension
#
- # Include this module if you want to check if an actor can act upon a specific subject
+ # Include this module if you want to check if an actor can act upon a specific subject.
+ # E.g. if your class is Actor, then include like this:
+ #
+ # class Actor < ActiveRecord::Base
+ # include Trust::Actor
+ # ...
+ # end
#
# ==== Examples
#
# # If the @actor can create customers, create it
# if @actor.can? :create, Customer