---
title: ReservedDocParamNames
description: >-
  Ensures LiquidDoc parameter names in block files don't reuse names reserved
  for the `content_for` tag.
source_url:
  html: >-
    https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/reserved-doc-param-names
  md: >-
    https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/reserved-doc-param-names.md
---

# Reserved​Doc​Param​Names

Parameters defined in [LiquidDoc](https://shopify.dev/docs/storefronts/themes/tools/liquid-doc) within a block file can't reuse names that are reserved for the [`content_for`](https://shopify.dev/docs/api/liquid/tags/content_for) tag. Because blocks can be rendered with `content_for`, a LiquidDoc parameter that reuses one of these reserved names would collide with the tag's arguments.

The reserved names are `attributes`, `block`, `blocks`, `class`, `context`, `id`, `inherit`, `resource`, `resources`, `schema`, `section`, `sections`, `settings`, `snippet`, `snippets`, `src`, `style`, `styles`, `template`, `templates`, and `type`.

This check only applies to files in the `blocks` directory.

***

## Examples

The following examples contain code snippets that either fail or pass this check.

### ✗ Fail

In the following example, a LiquidDoc parameter reuses the reserved `settings` name:

## blocks/block.liquid

```liquid
{% doc %}
  @param {string} settings - The block's settings
{% enddoc %}
```

### ✓ Pass

In the following example, the LiquidDoc parameters use names that aren't reserved:

## blocks/block.liquid

```liquid
{% doc %}
  @param {string} heading - The block's heading
  @param {number} columns - The number of columns to display
{% enddoc %}
```

***

## Options

The following example contains the default configuration for this check:

```yaml
ReservedDocParamNames:
  enabled: true
  severity: error
```

| Parameter | Description |
| - | - |
| `enabled` | Whether this check is enabled. |
| `severity` | The [severity](https://shopify.dev/docs/storefronts/themes/tools/theme-check/configuration#check-severity) of the check. |

***

## Disabling this check

Disabling this check isn't recommended.

***