ReservedDocParamNames

Parameters defined in LiquidDoc within a block file can't reuse names that are reserved for the 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.

Anchor to ExamplesExamples

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

Anchor to ✗ Fail✗ Fail

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

Anchor to ✓ Pass✓ Pass

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

Anchor to OptionsOptions

The following example contains the default configuration for this check:

Anchor to Disabling this checkDisabling this check

Disabling this check isn't recommended.