add documentation to include, fixes #163

2026-09-12 23:40:45 -07:00 · 2013-06-05 11:53:01 -04:00
parent 94ff457744
commit e92540a9bf
1 changed files with 22 additions and 7 deletions
@@ -1,4 +1,19 @@
 module Liquid
+
+  # Include allows templates to relate with other templates
+  #
+  # Simply include another template:
+  #
+  #   {% include 'product' %}
+  #
+  # Include a template with a local variable:
+  #
+  #   {% include 'product' with products[0] %}
+  #
+  # Include a template for a collection:
+  #
+  #   {% include 'product' for products %}
+  #
  class Include < Tag
    Syntax = /(#{QuotedFragment}+)(\s+(?:with|for)\s+(#{QuotedFragment}+))?/o