diff options
| author | Burdette Lamar <[email protected]> | 2022-03-21 14:58:00 -0500 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-03-21 14:58:00 -0500 |
| commit | c129b6119dfb8d53521b986465c3a85e08d874fe (patch) | |
| tree | cc22f0be21e0418239c5036be3c2e299241c77bd /doc/string/each_byte.rdoc | |
| parent | 1fd1f7bbfc5603cdcfa98363a9ec9e106705a0a3 (diff) | |
[DOC] Use RDoc inclusions in string.c (#5683)
As @peterzhu2118 and @duerst have pointed out, putting string method's RDoc into doc/ (which allows non-ASCII in examples) makes the "click to toggle source" feature not work for that method.
This PR moves the primary method doc back into string.c, then includes RDoc from doc/string/*.rdoc, and also removes doc/string.rdoc.
The affected methods are:
::new
#bytes
#each_byte
#each_line
#split
The call-seq is in string.c because it works there; it did not work when the call-seq is in doc/string/*.rdoc.
This PR also updates the relevant guidance in doc/documentation_guide.rdoc.
Notes
Notes:
Merged-By: BurdetteLamar <[email protected]>
Diffstat (limited to 'doc/string/each_byte.rdoc')
| -rw-r--r-- | doc/string/each_byte.rdoc | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/string/each_byte.rdoc b/doc/string/each_byte.rdoc new file mode 100644 index 0000000000..643118fea3 --- /dev/null +++ b/doc/string/each_byte.rdoc @@ -0,0 +1,17 @@ +Calls the given block with each successive byte from +self+; +returns +self+: + + 'hello'.each_byte {|byte| print byte, ' ' } + print "\n" + 'тест'.each_byte {|byte| print byte, ' ' } + print "\n" + 'こんにちは'.each_byte {|byte| print byte, ' ' } + print "\n" + +Output: + + 104 101 108 108 111 + 209 130 208 181 209 129 209 130 + 227 129 147 227 130 147 227 129 171 227 129 161 227 129 175 + +Returns an enumerator if no block is given. |