Skip to content

Commit

Permalink
Merge pull request Shopify#72 from zacstewart/patch-1
Browse files Browse the repository at this point in the history
Correct formatting for doc comments
  • Loading branch information
titanous committed Oct 16, 2011
2 parents 4026f6c + 6cf6d8b commit b816521
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions lib/liquid/drop.rb
@@ -1,21 +1,21 @@
module Liquid

# A drop in liquid is a class which allows you to to export DOM like things to liquid
# A drop in liquid is a class which allows you to to export DOM like things to liquid.
# Methods of drops are callable.
# The main use for liquid drops is the implement lazy loaded objects.
# If you would like to make data available to the web designers which you don't want loaded unless needed then
# a drop is a great way to do that
#
# Example:
#
# class ProductDrop < Liquid::Drop
# def top_sales
# Shop.current.products.find(:all, :order => 'sales', :limit => 10 )
# class ProductDrop < Liquid::Drop
# def top_sales
# Shop.current.products.find(:all, :order => 'sales', :limit => 10 )
# end
# end
# end
#
# tmpl = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {%endfor%} ' )
# tmpl.render('product' => ProductDrop.new ) # will invoke top_sales query.
# tmpl = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {%endfor%} ' )
# tmpl.render('product' => ProductDrop.new ) # will invoke top_sales query.
#
# Your drop can either implement the methods sans any parameters or implement the before_method(name) method which is a
# catch all
Expand Down

0 comments on commit b816521

Please sign in to comment.