1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use the word heredocs in Here Documents docs

Browse Source 
Two advantages:
- higher relevance of the extremely common word "heredocs" which may
help people find this page when searching for "ruby heredocs"
- the anchor link becomes `#label-Here+Documents+-28heredocs-29`, which is
ugly due to the parentheses but includes the word "heredocs" in the URL to
this section

If anyone knows a way to prevent RDoc from turning invalid characters into
ugly and meaningless ASCII codes, I'm listening. I don't want to break existing
anchor links but RDoc should really ignore these characters or turn them into
dashes.

Closes: https://github.com/ruby/ruby/pull/2103
This commit is contained in:
Olivier Lacan 2019-03-19 13:46:27 -04:00 committed by Hiroshi SHIBATA
parent 9311656914
commit 8e7df4bbf9
No known key found for this signature in database
GPG Key ID: F9CF13417264FAC2
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/syntax/literals.rdoc
View File

@ -193,7 +193,7 @@ a single codepoint in the script encoding:
?\C-\M-a #=> "\x81", same as above
?あ #=> "あ"
=== Here Documents
=== Here Documents (heredocs)
If you are writing a large block of text you may use a "here document" or
"heredoc":