summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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
2021-12-09[DOC] Stop mentioning Qfalse==0 for C extensionsAlan Wu
See [Feature #18397] for detail. Follow up for b859397e1b25a3f7847a380e7dd7db62f94fbe66. [ci skip] Co-authored-by: Koichi Sasada <ko1@atdot.net> Notes: Merged: https://github.com/ruby/ruby/pull/5240 Merged-By: XrXr
2021-12-09[DOC] Stop recommending Qfalse==0 assumption to C extensionsJemma Issroff
Encourage use of RTEST(), direct Qfalse comparison, and remove references to Qfalse == 0 in extension documentation. See [Bug #18397] for detail. [ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/5230 Merged-By: XrXr
2021-12-09Fix typo of namespaceaycabta
2021-12-09Fix typo in NEWS-2.5.0 [ci skip]Akihiro Sada
Notes: Merged: https://github.com/ruby/ruby/pull/5236 Merged-By: nobu <nobu@ruby-lang.org>
2021-12-06Enhanced RDoc for literals.rdoc (#5213)Burdette Lamar
Makes link targets among percent literals. Adds links to those targets. Adds examples to percent literals. Links from opening summary list to corresponding sections. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2021-12-03Adding links to literals and Kernel (#5192)Burdette Lamar
* Adding links to literals and Kernel Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2021-11-27Enhanced RDoc for numeric.c (#5184)Burdette Lamar
Adds remarks about literals and Kernel methods to Float and Integer. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2021-11-24update YJIT docs to reference RubyVM::YJIT instead of just YJITAdam Hess
[ci skip] Notes: Merged: https://github.com/ruby/ruby/pull/5171 Merged-By: XrXr
2021-11-24Fix typofurunkel
Notes: Merged: https://github.com/ruby/ruby/pull/5107
2021-11-18Anonymous block forwarding allows a method to forward a passedJeremy Evans
block to another method without having to provide a name for the block parameter. Implements [Feature #11256] Co-authored-by: Yusuke Endoh mame@ruby-lang.org Co-authored-by: Nobuyoshi Nakada nobu@ruby-lang.org Notes: Merged: https://github.com/ruby/ruby/pull/5051
2021-11-18Add --yjit-no-type-prop so we can test YJIT without type propagation (#5135)Maxime Chevalier-Boisvert
* Add --yjit-no-type-prop so we can test YJIT without type propagation * Fix typo in command line option * Leave just two test workflows enable for YJIT Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2021-11-10Mark IO::Buffer as experimental.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/4621
2021-11-10IO::Buffer for scheduler interface.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/4621
2021-11-07Revert "Fix typo in ChangeLog-2.0.0 [ci skip]"Kazuhiro NISHIYAMA
This reverts commit e5792e7d552235e17a93d50a26c375db1974148f. Because this is correct ChangeLog of https://github.com/ruby/ruby/commit/89fef02f1305887d97ddcf96cc4df9109ce414e2 and reverted commit makes inconsistency with https://github.com/ruby/ruby/commit/171c708b0c862ee92d6a46ac9def97193954638b
2021-11-06Fix typo in ChangeLog-2.0.0 [ci skip]180909
Notes: Merged: https://github.com/ruby/ruby/pull/5080 Merged-By: nobu <nobu@ruby-lang.org>
2021-11-04Fix typos [ci skip]Kazuhiro NISHIYAMA
2021-11-04fix typo in ChangeLog-1.9.3180909
Notes: Merged: https://github.com/ruby/ruby/pull/5076
2021-11-02Fix typos in ChangeLog files [ci skip]Nobuyoshi Nakada
2021-10-30Clarify docs about magic comments placementPeter Leitzen
Magic comments like `frozen_string_literal` may appear everywhere within the first comment section while `encoding` have to be the first line, or second line after shebang. Notes: Merged: https://github.com/ruby/ruby/pull/4985
2021-10-26Fix TypoSteven Nunez
Notes: Merged: https://github.com/ruby/ruby/pull/5028
2021-10-23update doc/ractor.md about ivarsKoichi Sasada
Notes: Merged: https://github.com/ruby/ruby/pull/5006
2021-10-21Move the test fileNobuyoshi Nakada
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-22 14:25:18 +0000