1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/doc
Burdette Lamar c129b6119d
[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.
2022-03-21 14:58:00 -05:00
..
csv
images
irb
NEWS [DOC] Move old NEWS files to a separate directory 2022-03-22 01:37:34 +09:00
optparse [ruby/optparse] Fix links to the page directory files [Bug #18468] 2022-01-12 21:16:02 +09:00
pty
string [DOC] Use RDoc inclusions in string.c (#5683) 2022-03-21 14:58:00 -05:00
syntax [DOC] Prefer the original file names over generated names 2022-02-09 15:31:10 +09:00
time
yjit Fix yjit readme link pointing to old shopify readme (#5596) 2022-02-24 14:12:17 -05:00
.document [DOC] Move old NEWS files to a separate directory 2022-03-22 01:37:34 +09:00
bsearch.rdoc
bug_triaging.rdoc
case_mapping.rdoc Enhanced RDoc for case mapping (#5245) 2021-12-17 06:05:31 -06:00
ChangeLog-0.06_to_0.52
ChangeLog-0.50_to_0.60
ChangeLog-0.60_to_1.1 Fix typos in ChangeLog files [ci skip] 2021-11-02 19:17:37 +09:00
ChangeLog-1.8.0
ChangeLog-1.9.3 Fix typos [ci skip] 2021-11-04 12:58:09 +09:00
ChangeLog-2.0.0 Revert "Fix typo in ChangeLog-2.0.0 [ci skip]" 2021-11-07 13:13:32 +09:00
ChangeLog-2.1.0
ChangeLog-2.2.0
ChangeLog-2.3.0
ChangeLog-2.4.0 Fix typos in ChangeLog files [ci skip] 2021-11-02 19:17:37 +09:00
ChangeLog-YARV Fix typos in ChangeLog files [ci skip] 2021-11-02 19:17:37 +09:00
character_selectors.rdoc [DOC] Enhanced RDoc for String (#5635) 2022-03-09 19:53:51 -06:00
command_injection.rdoc Enhanced RDoc concerning command injection (#5537) 2022-02-18 06:46:04 -06:00
contributing.rdoc
dig_methods.rdoc
documentation_guide.rdoc [DOC] Use RDoc inclusions in string.c (#5683) 2022-03-21 14:58:00 -05:00
dtrace_probes.rdoc
encoding.rdoc [DOC] Addition to encoding.rdoc (#5617) 2022-03-02 14:26:20 -06:00
extension.ja.rdoc Revert "[DOC] Mention RBOOL in extension.rdoc [Feature #13125]" 2022-01-09 19:17:48 +09:00
extension.rdoc Make the Ractor-safe section more fluent 2022-01-10 13:08:59 +01:00
fiber.md Mark IO::Buffer as experimental. 2021-11-10 19:21:05 +13:00
forwardable.rd.ja
globals.rdoc
hacking.md [DOC] Link to Ruby Spec and rephrase project goal 2022-01-10 18:02:00 +01:00
implicit_conversion.rdoc
keywords.rdoc
maintainers.rdoc
make_cheatsheet.md
marshal.rdoc
memory_view.md Fix typos [ci skip] 2022-03-04 11:28:25 +09:00
ractor.md [DOC] Fix case for new sentence. 2022-01-31 07:59:10 +09:00
regexp.rdoc Add documentation for regexp emoji named character property 2022-02-04 08:26:49 +09:00
security.rdoc
signals.rdoc
standard_library.rdoc
syntax.rdoc
transcode.rdoc [DOC] Rename doc/*.rb as doc/*.rdoc 2022-03-03 13:37:37 +09:00
yarvarch.en
yarvarch.ja