Labyricorn/liquid
1
0
Fork 0
mirror of https://github.com/Shopify/liquid.git synced 2026-09-12 23:40:45 -07:00
Code Issues Packages Projects Releases Wiki Activity

Correct formatting for doc comments

Browse Source 
Portions of the code examples were not being rendered as code because they lacked a leading tab. Also, a missing period on the first sentence made the first paragraph confusing.
This commit is contained in:
Zac
2011-09-10 10:36:22 -03:00
parent 1379061398
commit 6cf6d8b990
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/liquid/drop.rb
+7 -7
View File
@@ -1,6 +1,6 @@
module Liquid 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. # Methods of drops are callable.
# The main use for liquid drops is the implement lazy loaded objects. # 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 # If you would like to make data available to the web designers which you don't want loaded unless needed then
@@ -8,14 +8,14 @@ module Liquid
# #
# Example: # Example:
# #
# class ProductDrop < Liquid::Drop # class ProductDrop < Liquid::Drop
# def top_sales # def top_sales
# Shop.current.products.find(:all, :order => 'sales', :limit => 10 ) # Shop.current.products.find(:all, :order => 'sales', :limit => 10 )
# end
# end # end
# end
# #
# tmpl = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {%endfor%} ' ) # tmpl = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {%endfor%} ' )
# tmpl.render('product' => ProductDrop.new ) # will invoke top_sales query. # 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 # Your drop can either implement the methods sans any parameters or implement the before_method(name) method which is a
# catch all # catch all