[ruby-core:71705] [Ruby trunk - Bug #11746] [Open] RDoc incorrect example call method on heredoc

[ruby-core:71705] [Ruby trunk - Bug #11746] [Open] RDoc incorrect example call method on heredoc

[jmgcrespo]

Issue #11746 has been reported by Jose Manuel Garcia.

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746

* Author: Jose Manuel Garcia
* Status: Open
* Priority: Normal
* Assignee: 
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/

[ruby-core:71778] [Ruby trunk - Bug #11746] RDoc incorrect example call method on heredoc

[jmgcrespo]

Issue #11746 has been updated by Jose Manuel Garcia.

Assignee set to Jose Manuel Garcia

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746#change-55187

* Author: Jose Manuel Garcia
* Status: Open
* Priority: Normal
* Assignee: Jose Manuel Garcia
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/

[ruby-core:71780] [Ruby trunk - Bug #11746] RDoc incorrect example call method on heredoc

[jmgcrespo]

Issue #11746 has been updated by Jose Manuel Garcia.

Assignee deleted (Jose Manuel Garcia)

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746#change-55190

* Author: Jose Manuel Garcia
* Status: Open
* Priority: Normal
* Assignee: 
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/

[ruby-core:71884] [Ruby trunk - Bug #11746] RDoc incorrect example call method on heredoc

[ko1]

Issue #11746 has been updated by Koichi Sasada.

Assignee set to Zachary Scott

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746#change-55289

* Author: Jose Manuel Garcia
* Status: Open
* Priority: Normal
* Assignee: Zachary Scott
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/

[ruby-core:73341] [Ruby trunk - Bug #11746] RDoc incorrect example call method on heredoc

[andrew]

Issue #11746 has been updated by 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)
```

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746#change-56569

* Author: Jose Manuel Garcia
* Status: Open
* Priority: Normal
* Assignee: Zachary Scott
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/

[ruby-core:91061] [Ruby trunk Bug#11746] RDoc incorrect example call method on heredoc

[hsbt]

Issue #11746 has been updated by hsbt (Hiroshi SHIBATA).

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

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746#change-76280

* Author: manuel (Jose Manuel Garcia)
* Status: Assigned
* Priority: Normal
* Assignee: aycabta (aycabta .)
* Target version: 
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/

[ruby-core:93896] [Ruby master Bug#11746] RDoc incorrect example call method on heredoc

[merch-redmine]

Issue #11746 has been updated by 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).

----------------------------------------
Bug #11746: RDoc incorrect example call method on heredoc
https://bugs.ruby-lang.org/issues/11746#change-79936

* Author: manuel (Jose Manuel Garcia)
* Status: Closed
* Priority: Normal
* Assignee: aycabta (aycabta .)
* Target version: 
* ruby -v: 
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN, 2.2: UNKNOWN
----------------------------------------
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





-- 
https://bugs.ruby-lang.org/