ValidDocParamNames
Each parameter defined in LiquidDoc should not collide with liquid tags.
Anchor to ExamplesExamples
The following examples contain code snippets that fail this check.
Anchor to ✗ Fail✗ Fail
The following example shows multiple parameters that share names with liquid tags:
{% doc %}
@param {string} render
@param {string} assign
{% enddoc %}
Anchor to OptionsOptions
The following example contains the default configuration for this check:
ValidDocParamNames
enabledtrue
severitywarning
| 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?