From 667664bb22fb6b1c60e5ca8b42faa2609d5b6b5b Mon Sep 17 00:00:00 2001 From: Shaina Raskas Date: Fri, 11 Nov 2022 15:34:35 -0500 Subject: [PATCH 1/3] clarify inline_comment --- lib/liquid/tags/inline_comment.rb | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/lib/liquid/tags/inline_comment.rb b/lib/liquid/tags/inline_comment.rb index e2cbc138..594d08ed 100644 --- a/lib/liquid/tags/inline_comment.rb +++ b/lib/liquid/tags/inline_comment.rb @@ -4,13 +4,10 @@ module Liquid # @liquid_public_docs # @liquid_type tag # @liquid_category syntax - # @liquid_name inline_comment + # @liquid_name inline comment # @liquid_summary - # Prevents an expression from being rendered or output. + # Prevents an expression inside of a tag `{% %}` from being rendered or output. # @liquid_description - # Any text inside an `inline_comment` tag won't be rendered or output. - # - # You can create multi-line inline comments. However, each line must begin with a `#`. # @liquid_syntax # {% # content %} # @liquid_syntax_keyword content The content of the comment. From 474315c6bb8c03b6025433b59af0d7d470c71bd3 Mon Sep 17 00:00:00 2001 From: Shaina Raskas Date: Fri, 11 Nov 2022 16:03:52 -0500 Subject: [PATCH 2/3] edits --- lib/liquid/tags/inline_comment.rb | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) 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 From 8b1b9f649af7c865cd96a09e60e4c09929b31c1a Mon Sep 17 00:00:00 2001 From: Shaina Raskas Date: Fri, 11 Nov 2022 16:21:18 -0500 Subject: [PATCH 3/3] remove separate inline comment tag for IA reasons --- lib/liquid/tags/inline_comment.rb | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/lib/liquid/tags/inline_comment.rb b/lib/liquid/tags/inline_comment.rb index b378d7c2..493cfddc 100644 --- a/lib/liquid/tags/inline_comment.rb +++ b/lib/liquid/tags/inline_comment.rb @@ -1,19 +1,6 @@ # frozen_string_literal: true module Liquid - # @liquid_public_docs - # @liquid_type tag - # @liquid_category syntax - # @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 tag. class InlineComment < Tag def initialize(tag_name, markup, options) super