Browse files

Cleaned up existing rdoc a little.

  • Loading branch information...
1 parent a35c231 commit 5e3631538ea6c256d6d6bb74fb945315880148d3 @technicalpickles technicalpickles committed with Feb 19, 2008
Showing with 23 additions and 14 deletions.
  1. +23 −14 lib/ambition/context.rb
View
37 lib/ambition/context.rb
@@ -1,23 +1,32 @@
module Ambition #:nodoc:
+ # This class includes several methods you will likely want to be accessing through your
+ # Query and Translator classes:
+ #
+ # * +clauses+
+ # * +owner+
+ # * +stash+
class Context
undef_method :to_s
include API
-
- ##
- # These are the methods your Query and Translator classes will
- # want to access.
- #
- # +owner+ The class everything was called on. Like `User'
+
+ # A hash of arrays, one key per processor.
+ # So, if someone called User.select, your
+ # +clauses+ hash would have a :select key with
+ # an array of translated strings via your Select
+ # class.
+ #
+ # This is accessible from your Query and Translator classes.
+ attr_reader :clauses
+
+ # The class everything was called on. Like `User`
#
- # +clauses+ A hash of arrays, one key per processor.
- # So, if someone called User.select, your
- # +clauses+ hash would have a :select key with
- # an array of translated strings via your Select
- # class.
+ # This is accessible from your Query and Translator classes.
+ attr_reader :owner
+
+ # A place for you to stick stuff. Available to all Translators and your Query class.
#
- # +stash+ A place for you to stick stuff. Available to
- # all Translators and your Query class.
- attr_reader :clauses, :owner, :stash
+ # This is accessible from your Query and Translator classes.
+ attr_reader :stash
def initialize(owner)
@owner = owner

0 comments on commit 5e36315

Please sign in to comment.