Module: Yard::Lint::Validators::Documentation::LineLength

Defined in:

lib/yard/lint/validators/documentation/line_length.rb,
lib/yard/lint/validators/documentation/line_length/config.rb,
lib/yard/lint/validators/documentation/line_length/parser.rb,
lib/yard/lint/validators/documentation/line_length/result.rb,
lib/yard/lint/validators/documentation/line_length/validator.rb,
lib/yard/lint/validators/documentation/line_length/messages_builder.rb

Overview

LineLength validator

Detects documentation comment lines that exceed a configured maximum length. Only checks lines belonging to YARD docstring blocks (comment lines directly above a documentable Ruby construct). YARD’s parsed docstring is used to determine which lines belong to a docstring, avoiding fragile backwards-scanning.

Disabled by default — enable it and set MaxLength to taste.

## Configuration

To enable with a custom limit:

Documentation/LineLength:
  Enabled: true
  MaxLength: 100

To disable:

Documentation/LineLength:
  Enabled: false

Examples:

Bad - line exceeds MaxLength (120)

# This documentation line is too long and exceeds the configured maximum length.
def process(value)
end

Good - line within MaxLength

# Process the given value.
def process(value)
end

Defined Under Namespace

Classes: Config, MessagesBuilder, Parser, Result, Validator