diff --git a/lib/liquid/tags/inline_comment.rb b/lib/liquid/tags/inline_comment.rb index 594d08ed..b378d7c2 100644 --- a/lib/liquid/tags/inline_comment.rb +++ b/lib/liquid/tags/inline_comment.rb @@ -4,13 +4,16 @@ module Liquid # @liquid_public_docs # @liquid_type tag # @liquid_category syntax - # @liquid_name inline comment + # @liquid_name inline comments # @liquid_summary # Prevents an expression inside of a tag `{% %}` from being rendered or output. # @liquid_description + # You can use inline comment tags to annotate your code, or to temporarily prevent logic in your code from executing. + # + # You can create multi-line inline comments. However, each line in the tag must begin with a `#`, or a syntax error will occur. # @liquid_syntax # {% # content %} - # @liquid_syntax_keyword content The content of the comment. + # @liquid_syntax_keyword content The content of the tag. class InlineComment < Tag def initialize(tag_name, markup, options) super