Skip to content

Commit

Permalink
Tidying up Entity documentation.
Browse files Browse the repository at this point in the history
The entity documentation was a bit off. Including Lotus::Model did
not create the three defined methods.
  • Loading branch information
jeremyf committed Apr 26, 2014
1 parent 6e80372 commit 8950276
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions lib/lotus/entity.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,14 @@ module Lotus
# self.attributes = :name, :age
# end
#
# When a class includes `Lotus::Entity` it will receive the following interface:
# When a class includes `Lotus::Entity` the `.attributes=` method is exposed.
# By then calling the `.attributes=` class method, the following methods are
# added:
#
# * #id
# * #id=
# * #initialize(attributes = {})
#
# Also, the usage of `.attributes=` defines accessors for the given attribute
# names.
#
# If we expand the code above in pure Ruby, it would be:
#
# @example Pure Ruby
Expand Down

0 comments on commit 8950276

Please sign in to comment.