mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
c129b6119d
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.
60 lines
1.2 KiB
Text
60 lines
1.2 KiB
Text
With a block given, forms the substrings ("lines")
|
|
that are the result of splitting +self+
|
|
at each occurrence of the given line separator +line_sep+;
|
|
passes each line to the block;
|
|
returns +self+:
|
|
|
|
s = <<~EOT
|
|
This is the first line.
|
|
This is line two.
|
|
|
|
This is line four.
|
|
This is line five.
|
|
EOT
|
|
|
|
s.each_line {|line| p line }
|
|
|
|
Output:
|
|
|
|
"This is the first line.\n"
|
|
"This is line two.\n"
|
|
"\n"
|
|
"This is line four.\n"
|
|
"This is line five.\n"
|
|
|
|
With a different +line_sep+:
|
|
|
|
s.each_line(' is ') {|line| p line }
|
|
|
|
Output:
|
|
|
|
"This is "
|
|
"the first line.\nThis is "
|
|
"line two.\n\nThis is "
|
|
"line four.\nThis is "
|
|
"line five.\n"
|
|
|
|
With +chomp+ as +true+, removes the trailing +line_sep+ from each line:
|
|
|
|
s.each_line(chomp: true) {|line| p line }
|
|
|
|
Output:
|
|
|
|
"This is the first line."
|
|
"This is line two."
|
|
""
|
|
"This is line four."
|
|
"This is line five."
|
|
|
|
With an empty string as +line_sep+,
|
|
forms and passes "paragraphs" by splitting at each occurrence
|
|
of two or more newlines:
|
|
|
|
s.each_line('') {|line| p line }
|
|
|
|
Output:
|
|
|
|
"This is the first line.\nThis is line two.\n\n"
|
|
"This is line four.\nThis is line five.\n"
|
|
|
|
With no block given, returns an enumerator.
|