Skip to content

Commit

Permalink
Added intro documentation for syntaxes
Browse files Browse the repository at this point in the history
  • Loading branch information
jferris committed Feb 17, 2009
1 parent 6aa594f commit f28dad4
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 4 deletions.
12 changes: 12 additions & 0 deletions lib/factory_girl/syntax.rb
@@ -0,0 +1,12 @@
class Factory
# Provides alternate syntaxes for factory_girl. If you don't like the default
# syntax for defining or using factories, look at one of the Factory::Syntax
# modules:
#
# * Factory::Syntax::Blueprint: definition syntax similar to Machinist
# * Factory::Syntax::Generate: usage syntax similar to Object Daddy
# * Factory::Syntax::Make: usage syntax similar to Machinist
# * Factory::Syntax::Sham: sequence syntax similar to Machinist
module Syntax
end
end
2 changes: 1 addition & 1 deletion lib/factory_girl/syntax/blueprint.rb
@@ -1,5 +1,5 @@
class Factory
module Syntax #:nodoc:
module Syntax

# Extends ActiveRecord::Base to provide a make class method, which is an
# alternate syntax for defining factories.
Expand Down
2 changes: 1 addition & 1 deletion lib/factory_girl/syntax/generate.rb
@@ -1,5 +1,5 @@
class Factory
module Syntax #:nodoc:
module Syntax

# Extends ActiveRecord::Base to provide generation methods for factories.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/factory_girl/syntax/make.rb
@@ -1,5 +1,5 @@
class Factory
module Syntax #:nodoc:
module Syntax

# Extends ActiveRecord::Base to provide a make class method, which is a
# shortcut for Factory.create.
Expand Down
2 changes: 1 addition & 1 deletion lib/factory_girl/syntax/sham.rb
@@ -1,5 +1,5 @@
class Factory
module Syntax #:nodoc:
module Syntax

# Adds a Sham module, which provides an alternate interface to
# Factory::Sequence.
Expand Down

0 comments on commit f28dad4

Please sign in to comment.