Module: Yard::Lint::Validators::Documentation::BlankLineBeforeDefinition

Defined in:

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

Overview

BlankLineBeforeDefinition validator

Detects blank lines between YARD documentation and method/class/module definitions. YARD requires documentation to be immediately adjacent to the definition it documents.

## Severity Levels

• **1 blank line**: Convention violation - YARD associates the doc but this violates formatting conventions

• **2+ blank lines**: Orphaned documentation - YARD ignores the documentation entirely

## Configuration

To customize severity levels:

Documentation/BlankLineBeforeDefinition:
  Severity: warning           # For single blank line
  OrphanedSeverity: error     # For 2+ blank lines

To check only single blank lines:

Documentation/BlankLineBeforeDefinition:
  EnabledPatterns:
    SingleBlankLine: true
    OrphanedDocs: false

To disable this validator:

Documentation/BlankLineBeforeDefinition:
  Enabled: false

Examples:

Bad - Single blank line (convention violation)

# Description of the method
# @param value [String] the value

def process(value)
end

Bad - Multiple blank lines (orphaned documentation)

# Description of the method
# @param value [String] the value

def process(value)
end

Good - No blank lines

# Description of the method
# @param value [String] the value
def process(value)
end

Defined Under Namespace

Classes: Config, MessagesBuilder, Parser, Result, Validator