diff options
| author | Olivier Lacan <hi@olivierlacan.com> | 2019-03-19 13:46:27 -0400 |
|---|---|---|
| committer | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2019-08-04 09:18:48 +0900 |
| commit | 8e7df4bbf991b9d605784225db0750bbfe681f23 (patch) | |
| tree | 32c04194f7ca80e2ceaeec6d26d1bab3971caff6 /doc | |
| parent | 93116569145bbff34355e08722c6689487d8b858 (diff) | |
| download | ruby-8e7df4bbf991b9d605784225db0750bbfe681f23.tar.gz | |
Use the word heredocs in Here Documents docs
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/syntax/literals.rdoc | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/syntax/literals.rdoc b/doc/syntax/literals.rdoc index 0cde9447c5..38bfa38676 100644 --- a/doc/syntax/literals.rdoc +++ b/doc/syntax/literals.rdoc @@ -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": |