UniqueDocParamNames
Each parameter defined in LiquidDoc needs to have a unique name.
Anchor to ExamplesExamples
The following examples contain code snippets that either fail or pass this check.
Anchor to ✗ Fail✗ Fail
In the following example, there are two parameters defined in LiquidDoc with the same name:
{% doc %}
@param {string} some_input
@param {number} some_input
{% enddoc %}
Anchor to ✓ Pass✓ Pass
In the following example, all the parameters in LiquidDoc have different names:
{% doc %}
@param {string} some_str
@param {number} some_num
{% enddoc %}
Anchor to OptionsOptions
The following example contains the default configuration for this check:
UniqueDocParamNames
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?