summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-04-03[DOC] Describe append_{c,cpp,ld}flagsv3_2_0_preview1Nobuyoshi Nakada
2022-04-02[DOC] Enhanced RDoc for String (#5751)Burdette Lamar
Adds to doc for String.new, also making it compliant with documentation_guide.rdoc. Fixes some broken links in io.c (that I failed to correct yesterday). Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-02[DOC] Fix broken links to encodings.rdocNobuyoshi Nakada
Also prefers class name based references than file name based references.
2022-04-01[DOC] Main doc for encodings moved from encoding.c to doc/encodings.rdoc (#5748)Burdette Lamar
Main doc for encodings moved from encoding.c to doc/encodings.rdoc Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-31[DOC] Enhanced RDoc for String (#5742)Burdette Lamar
Treats: #force_encoding #b #valid_encoding? #ascii_only? #scrub #scrub! #unicode_normalized? Plus a couple of minor tweaks. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-30doc/regexp.rdoc: Add explanation about Regexp timeout configurationYusuke Endoh
Notes: Merged: https://github.com/ruby/ruby/pull/5703
2022-03-29[DOC] Enhanced RDoc for String (#5730)Burdette Lamar
Treats: #start_with? #end_with? #delete_prefix #delete_prefix! #delete_suffix #delete_suffix! Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-28[DOC] Enhanced RDoc for String (#5726)Burdette Lamar
Treats: #ljust #rjust #center #partition #rpartition Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-27[DOC] Enhanced RDoc for String (#5724)Burdette Lamar
Treats: #scan #hex #oct #crypt #ord #sum Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-24[DOC] Enhanced RDoc for String (#5707)Burdette Lamar
Treated: #chomp #chomp! #chop #chop! Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-24[DOC] Refine flip-flopNobuyoshi Nakada
2022-03-24Add Yuta Saito (katei) as the platform maintainer of WebAssembly/WASIYusuke Endoh
Notes: Merged: https://github.com/ruby/ruby/pull/5702
2022-03-22[DOC] Enhanced RDoc for String (#5685)Burdette Lamar
Treats: #chars #codepoints #each_char #each_codepoint #each_grapheme_cluster #grapheme_clusters Also, corrects a passage in #unicode_normalize that mentioned module UnicodeNormalize, whose doc (:nodoc:, actually) says not to mention it. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-22[DOC] re-count test suites run by `make check` [ci skip]Nobuyoshi Nakada
2022-03-21[DOC] Use RDoc inclusions in string.c (#5683)Burdette Lamar
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: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-22[DOC] Move old NEWS files to a separate directoryNobuyoshi Nakada
2022-03-18[DOC] Enhanced RDoc for String (#5675)Burdette Lamar
Treats: #split #each_line #lines #each_byte #bytes Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-16[DOC] Enhanced RDoc for String#split (#5644)Burdette Lamar
* Enhanced RDoc for String#split * Enhanced RDoc for String#split * Enhanced RDoc for String#split * Enhanced RDoc for String#split * Enhanced RDoc for String#split Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-16[DOC] Prefer local rdoc linksNobuyoshi Nakada
- ensures exact same version - avoid generated URLs - no external access - concise
2022-03-11Adding guidance about characters in C-code doc (#5641)Burdette Lamar
Showing how to do as @nobu does -- putting doc into doc/*.rdoc instead of in *.c. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-09[DOC] Enhanced RDoc for String (#5635)Burdette Lamar
Treats: #count #delete #delete! #squeeze #squeeze! Adds section "Multiple Character Selectors" to doc/character_selectors.rdoc. Co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-10[DOC] Remove an unnecessary character [ci skip]Kazuhiro NISHIYAMA
2022-03-09[DOC] Enhanced RDoc for String (#5633)Burdette Lamar
Treats: #tr (revised to link to "Character Selectors" document) #tr! #tr_s #tr_s! Also renames doc/character_selector.rdoc to match its title. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-08[DOC] RDoc for character selectors (#5632)Burdette Lamar
This file will be a link target for methods doc that cites character selectors (e.g., String#tr), It covers only the character selector; +replacement+ is discussed at String#tr (which will be revised and simplified); multiple selectors will be discussed at String#delete and String#count. Co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-07[DOC] Change to guidance on lists in What's Here section (#5618)Burdette Lamar
Currently, the guide says a "What's Here" section should have a labeled list for the methods. Such a list can render very differently in different browsers, and are often erratic in their indentation of continuation lines. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-05Mention removed gems since 3.1 [ci skip]Kazuhiro NISHIYAMA
2022-03-04Fix typos [ci skip]Kazuhiro NISHIYAMA
2022-03-03[DOC] Rename doc/*.rb as doc/*.rdocNobuyoshi Nakada
With `:markup: ruby` directive so that they are parsed as ruby scripts.
2022-03-02[DOC] Addition to encoding.rdoc (#5617)Burdette Lamar
Adds section "Transcoding a Stream," listing relevant methods in IO. Moves an example from section "String Encoding Example" to the new section. Removes header "String Encoding Example" for now-empty section. Changes items in section "Transcoding a String" from labeled list items to bullet list items. (Labeled list items are sometimes rendered with strange indentations for continued lines, and are always rendered with different indentations for the items.) Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-03-01[DOC] Add encoding external/internal example to encoding.rdoc (#5610)Burdette Lamar
* Add encoding external/internal example to encoding.rdoc * Add encoding external/internal example to encoding.rdoc * Update doc/encoding.rdoc I think there may be some more of these that I've recently put into io.c. Will check tomorrow and create new PR if so. Co-authored-by: Peter Zhu <peter@peterzhu.ca> Co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-02-27[DOC] Enhanced RDoc for encoding (#5603)Burdette Lamar
Additions and corrections for external/internal encodings. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-02-27[DOC] Extend intro/defn of 'transcoding' (#5602)Burdette Lamar
* Extend intro/defn of 'transcoding' Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-02-26[DOC] Move String.new to allow non US-ASCII charactersNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/5410
2022-02-26[DOC] Fix the pseudo codeNobuyoshi Nakada
2022-02-26[DOC] Place a non-US-ASCII document in a document-specific scriptNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/5601
2022-02-24[DOC] Enhancements for encoding.rdoc (#5578)Burdette Lamar
Adds sections: String Encoding Symbol and Regexp Encodings Filesystem Encoding Locale Encoding IO Encodings External Encoding Internal Encoding Script Encoding Transcoding Transcoding a String Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-02-24Fix yjit readme link pointing to old shopify readme (#5596)Adrien S
Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2022-02-18New doc about encoding (#5572)Burdette Lamar
This is the beginning of an extended explication of Ruby encoding. One of its more important jobs is to provide link targets for encoding documentation in other classes (String, File, IO, etc.). In particular, they can link to the "Encoding Options" section. I'll have much to add to this document going forward, along with suitable adjustments in the class documentation. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-02-18Enhanced RDoc concerning command injection (#5537)Burdette Lamar
Clarifies security vulnerabilities for commands. Treats: Kernel.system Kernel.` (backtick) IO.popen IO.read IO.write IO.binread IO.binwrite IO.readlines IO.foreach Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-02-09[DOC] Prefer the original file names over generated namesNobuyoshi Nakada
Should also the label in an explicit `rdoc-ref:` link be converted in the future?
2022-02-04Add documentation for regexp emoji named character propertyMax Leopold
Notes: Merged: https://github.com/ruby/ruby/pull/5524
2022-02-02Fix a typo [ci skip]Kazuhiro NISHIYAMA
2022-01-31[DOC] Fix case for new sentence.Steven Nunez
Notes: Merged: https://github.com/ruby/ruby/pull/5505 Merged-By: nobu <nobu@ruby-lang.org>
2022-01-15Add Enumerable::Lazy#with_index to NEWS-2.7.0manga_osyo
The behavior of `Enumerable::Lazy#with_index` has changed in Ruby 2.7. This change was not listed in the Ruby 2.7 news, so I added it. Notes: Merged: https://github.com/ruby/ruby/pull/4225
2022-01-12[ruby/optparse] Fix links to the page directory files [Bug #18468]Nobuyoshi Nakada
https://github.com/ruby/optparse/commit/dab72c543d
2022-01-12[ruby/optparse] Add .document filesNobuyoshi Nakada
https://github.com/ruby/optparse/commit/ed283559d4
2022-01-11YJIT stats documentation additions and updates (#5427)Noah Gibbs
* YJIT documentation additions and updates * Update yjit.md Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com> Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2022-01-10[DOC] Link to Ruby Spec and rephrase project goalAlan Wu
The word "specification" can be confusing as it might make readers assume that the Ruby Spec Suite is a specification similar to an ISO specification. Avoid the word and link to the project so curious parties could read more about the project. Notes: Merged: https://github.com/ruby/ruby/pull/5423
2022-01-10Make the Ractor-safe section more fluentBenoit Daloze
2022-01-10Clarify ractor documentation meaning and formatting.Trey Evans
Notes: Merged: https://github.com/ruby/ruby/pull/5421
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-21 03:22:02 +0000