Bug #11746: RDoc incorrect example call method on heredoc

• Status: Closed
• Priority: Normal
• Assignee: aycabta (aycabta .)
• Target version: -
• Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN

[manuel (Jose Manuel Garcia)]

The sample code for a call on a heredoc at http://ruby-doc.org/core-2.3.0_preview1/doc/syntax/literals_rdoc.html#label-Here+Documents
for

To call a method on a heredoc place it after the opening identifier:

I think it should be

expected_result = <<HEREDOC.chomp
One plus one is #{1 + 1}
HEREDOC

instead of

expected_result = "One plus one is #{1 + 1}
".chomp

Regards

[manuel (Jose Manuel Garcia)]

• Assignee set to manuel (Jose Manuel Garcia)

[manuel (Jose Manuel Garcia)]

• Assignee deleted (manuel (Jose Manuel Garcia))

[ko1 (Koichi Sasada)]

• Assignee set to zzak (Zak Scott)

[avit (Andrew Vit)]

This looks like a limitation in the RDoc ruby lexer. The documentation in doc/syntax/literals.rdoc looks correct.

Compare the outputs here:

require 'rdoc'
options = nil
ruby = [
  'expected_result = <<-EXPECTED.chomp', 
  'One plus one is #{1 + 1}', 
  'EXPECTED'
].join("\n")

puts RDoc::RubyLex.tokenize(ruby, options)
puts RDoc::RubyLex.tokenize(ruby.gsub(".chomp", ""), options)

[hsbt (Hiroshi SHIBATA)]

• Status changed from Open to Assigned
• Assignee changed from zzak (Zak Scott) to aycabta (aycabta .)

[jeremyevans0 (Jeremy Evans)]

• Status changed from Assigned to Closed

It looks like this issue has been resolved in the current version of RDoc (see https://docs.ruby-lang.org/en/trunk/syntax/literals_rdoc.html).