UniqueDocParamNames

UniqueDocParamNames

Severity: error | Type: LiquidHtml

This check ensures that all @param entries in a {% doc %} tag have unique names. Duplicate parameter names in a {% doc %} block are always a mistake — only one declaration would be effective, and the duplication causes confusion for readers and tooling.

Examples

✗ Incorrect Code Example (Avoid using this):

{% doc %}
  @param {string} title - The card title
  @param {string} title - Duplicate title param
  @param {string} description - The card description
{% enddoc %}

title is declared twice.

✓ Correct Code Example (Use this instead):

{% doc %}
  @param {string} title - The card title
  @param {string} description - The card description
{% enddoc %}

Configuration

The default configuration for this check:

UniqueDocParamNames:
  enabled: true
  severity: error

Disabling This Check

Disabling this check is not recommended. Duplicate parameter names are always a mistake.

Resources

• LiquidDoc doc tag