Project

General

Profile

Bug #11746

RDoc incorrect example call method on heredoc

Added by manuel (Jose Manuel Garcia) over 3 years ago. Updated 4 months ago.

Status:
Assigned
Priority:
Normal
Target version:
-
[ruby-core:71705]

Description

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

History

Updated by manuel (Jose Manuel Garcia) over 3 years ago

  • Assignee set to manuel (Jose Manuel Garcia)

Updated by manuel (Jose Manuel Garcia) over 3 years ago

  • Assignee deleted (manuel (Jose Manuel Garcia))

Updated by ko1 (Koichi Sasada) over 3 years ago

  • Assignee set to zzak (Zachary Scott)

Updated by avit (Andrew Vit) over 3 years ago

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)

Updated by hsbt (Hiroshi SHIBATA) 4 months ago

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

Also available in: Atom PDF