Skip to content

Maintenance Ruby 3.4 gets fixes, but no new features. Switch to Ruby 4.0 →

instance method

OptionParser#summarize

(?::OptionParser::_LtLtString to, ?::Integer width, ?::Integer max, ?::String indent) ?{ (::String line) -> void } -> ::OptionParser::_LtLtString
summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk)

Puts option summary into to and returns to. Yields each line if a block is given.

to

Output destination, which must have method <<. Defaults to [].

width

Width of left side, defaults to @summary_width.

max

Maximum length allowed for left side, defaults to width - 1.

indent

Indentation, defaults to @summary_indent.

See also #separator #terminate #remove #to_a also in 4.1 · 4.0 · 3.3 · 3.2 · 3.1 · 3.0