Document break tag theme rendering behavior

Co-authored-by: Pi AI (openai/gpt-5.1) <[email protected]>
This commit is contained in:
Nathan Ferguson
2026-08-27 12:29:17 -04:00
co-authored by Pi AI
parent 807d45a6b3
commit f9257bf8c6
+14 -2
View File
@@ -3,19 +3,31 @@
module Liquid
# Break tag to be used to break out of a for loop.
#
# == Basic Usage:
# == Iteration usage:
# {% for item in collection %}
# {% if item.condition %}
# {% break %}
# {% endif %}
# {% endfor %}
#
# == Theme file rendering usage:
# {% if condition %}
# {% break %}
# {% endif %}
#
# @liquid_public_docs
# @liquid_type tag
# @liquid_category iteration
# @liquid_name break
# @liquid_summary
# Stops a [`for` loop](/docs/api/liquid/tags/for) from iterating.
# Stops a [`for` loop](/docs/api/liquid/tags/for) from iterating, or stops the
# rest of a file from rendering when used outside of a loop.
# @liquid_description
# Inside a `for` or `tablerow` loop, `break` stops the loop.
#
# Outside of a loop, `break` stops the rest of the current file from
# rendering. Sections, blocks, and snippets each render in their own context, so
# rendering continues normally in the file that rendered them.
# @liquid_syntax
# {% break %}
class Break < Tag