summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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
2022-01-09Revert "[DOC] Mention RBOOL in extension.rdoc [Feature #13125]"Nobuyoshi Nakada
This reverts commit 9ad34da47ff7d71446e667897559047ed5635b60, as `RBOOL` is not defined publicly yet.
2022-01-09[DOC] Fold too long linesNobuyoshi Nakada
2022-01-09[DOC] Mention `make check`Nobuyoshi Nakada
2022-01-09[DOC] test-spec would be preferable nowNobuyoshi Nakada
2022-01-09Don't combine test-all and rubyspec.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5420 Merged-By: ioquatix <samuel@codeotaku.com>
2021-12-30Add support for anonymous rest and keyword rest argument forwardingJeremy Evans
This allows for the following syntax: ```ruby def foo(*) bar(*) end def baz(**) quux(**) end ``` This is a natural addition after the introduction of anonymous block forwarding. Anonymous rest and keyword rest arguments were already supported in method parameters, this just allows them to be used as arguments to other methods. The same advantages of anonymous block forwarding apply to rest and keyword rest argument forwarding. This has some minor changes to #parameters output. Now, instead of `[:rest], [:keyrest]`, you get `[:rest, :*], [:keyrest, :**]`. These were already used for `...` forwarding, so I think it makes it more consistent to include them in other cases. If we want to use `[:rest], [:keyrest]` in both cases, that is also possible. I don't think the previous behavior of `[:rest], [:keyrest]` in the non-... case and `[:rest, :*], [:keyrest, :**]` in the ... case makes sense, but if we did want that behavior, we'll have to make more substantial changes, such as using a different ID in the ... forwarding case. Implements [Feature #18351] Notes: Merged: https://github.com/ruby/ruby/pull/5148
2021-12-28Expand URL to its canonical form [ci skip]Kazuhiro NISHIYAMA
2021-12-25Copy NEWS.md to doc/NEWS-3.1.0.md and update for 3.2.0Kazuhiro NISHIYAMA
2021-12-20[DOC] Add documentation for hash value omission syntaxVictor Shepelev
Notes: Merged: https://github.com/ruby/ruby/pull/5244 Merged-By: nobu <nobu@ruby-lang.org>
2021-12-18Fix code formatting.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5295
2021-12-18Introduce setup instructions for better parallelism.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5295
2021-12-18Initial hacking guide.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5294
2021-12-17Enhanced RDoc for case mapping (#5245)Burdette Lamar
Adds file doc/case_mapping.rdoc, which describes case mapping and provides a link target that methods doc can link to. Revises: String#capitalize String#capitalize! String#casecmp String#casecmp? String#downcase String#downcase! String#swapcase String#swapcase! String#upcase String#upcase! Symbol#capitalize Symbol#casecmp Symbol#casecmp? Symbol#downcase Symbol#swapcase Symbol#upcase Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2021-12-16Add description of ruby header files to extension.rdocLars Kanis
Notes: Merged: https://github.com/ruby/ruby/pull/4882
2021-12-13[DOC] Mention RBOOL in extension.rdoc [Feature #13125]Nobuyoshi Nakada
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-23 09:44:07 +0000