UnsupportedDocTag
The doc tag can only be used within a liquid snippet file.
Anchor to ExamplesExamples
The following examples contain code snippets that either fail or pass this check.
Anchor to ✗ Fail✗ Fail
The following example shows an invalid use of the doc tag:
sections/section.liquid
{% doc %}
@param {string} some_str
{% enddoc %}
Anchor to ✓ Pass✓ Pass
The following example shows a valid use of the doc tag with a single parameter:
snippets/snippet.liquid
{% doc %}
@param {string} some_str
{% enddoc %}
Anchor to OptionsOptions
The following example contains the default configuration for this check:
UnsupportedDocTag
enabledtrue
severityerror
| Parameter | Description |
|---|---|
enabled | Whether this check is enabled. |
severity | The severity of the check. |
Anchor to Disabling this checkDisabling this check
Disabling this check isn't recommended.
Was this page helpful?