summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-10-11YJIT: Improve build instructions for non-hackers (#11878)Alan Wu
Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2024-10-11[DOC] Tweak "Timezone Objects"Nobuyoshi Nakada
- Make method descriptions plain pragraphs in each method. - Make "Argument" and "Returns" note-lists. Notes: Merged: https://github.com/ruby/ruby/pull/11869
2024-10-09Added byroot to JSON maintainerHiroshi SHIBATA
[Misc #20746]
2024-10-07Update references to flori/jsonJean Boussier
Now that the repository was transfered, these links will become dead in a few months. Notes: Merged: https://github.com/ruby/ruby/pull/11820
2024-10-07YJIT: Add --yjit-mem-size option (#11810)Takashi Kokubun
* YJIT: Add --yjit-mem-size option * Improve --help * s/the region/this virtual memory region/ Co-authored-by: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com> --------- Co-authored-by: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com> Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2024-10-02[DOC] Fix typo in Forwardable docsNithin Bekal
Notes: Merged: https://github.com/ruby/ruby/pull/11759
2024-09-29[DOC] Refine about offset directivesNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/11721
2024-09-25doc: Remove description of experimental warnings related pattern matching ↵masatoshi_moritsuka
from documentation Ruby 3.2.0 has been released and all experimental warnings about pattern matching have been removed. Experimental warnings about pattern matching are no longer output, so I remove description about it from documentation as well. cf. https://bugs.ruby-lang.org/issues/18585 cf. db6b23c76cbc7888cd9a9912790c2068703afdd0 cf. https://twitter.com/k_tsj/status/1606956336037900289?s=20&t=-_PSYLhYPtYsB9FZhtXl5A Notes: Merged: https://github.com/ruby/ruby/pull/7052
2024-09-10[DOC] Fix linkBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11528
2024-09-02[ruby/rdoc] [DOC] Fix links (https://github.com/ruby/rdoc/pull/1169)Burdette Lamar
https://github.com/ruby/rdoc/commit/a576ff890f
2024-08-23Adds remarks about returned EnumeratorBurdetteLamar
2024-08-21[DOC] Include keywords.rdoc in doc/syntax/ (#11414)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2024-08-17[DOC] Add `$;` to the list of deprecated global variablesNeil Carvalho
Notes: Merged: https://github.com/ruby/ruby/pull/11392 Merged-By: nobu <nobu@ruby-lang.org>
2024-08-08YJIT: Allow tracing fallback counters (#11347)Takashi Kokubun
* YJIT: Allow tracing fallback counters * Update yjit.md about --yjit-trace-exits=counter Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2024-08-08[DOC] Add remark about in-brief for method docBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11330
2024-07-31[DOC] Adds "Further Considerations" to documentation_guide.md (#11281)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2024-07-29[ruby/rdoc] [DOC] Mods about markup formatsBurdette Lamar
(https://github.com/ruby/rdoc/pull/1143) https://github.com/ruby/rdoc/commit/011de3f2fd
2024-07-29Add remark about call-seqBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11261
2024-07-16Add MatchData#bytebegin and MatchData#byteendShugo Maeda
These methods return the byte-based offset of the beginning or end of the specified match. [Feature #20576]
2024-07-11YJIT: remove doc/yjit/yjit_hacking.md (#11153)Maxime Chevalier-Boisvert
Document is 3 years old and out of date
2024-07-11Update yjit.md, explain how to run a single test with test-all (#11151)Maxime Chevalier-Boisvert
2024-07-07[DOC] Fix typo `with` -> `wish`cdfzo
2024-07-05[DOC] yjit.md: Markdown fixes for RDocAlan Wu
It now renders properly on both GitHub and with RDoc's darkfish theme.
2024-07-01[ruby/irb] fix typos in the `Index of Command-Line Options`Anatoly Busygin
https://github.com/ruby/irb/commit/3512020f1c
2024-06-26[DOC] Doc for exceptions (#11008)Burdette Lamar
2024-06-26Mentioned new mswin tasks related with vcpkgHiroshi SHIBATA
2024-06-26Added git for requirements of Windows buildHiroshi SHIBATA
2024-06-19String.new(capacity:) don't substract termlenJean Boussier
[Bug #20585] This was changed in 36a06efdd9f0604093dccbaf96d4e2cb17874dc8 because `String.new(1024)` would end up allocating `1025` bytes, but the problem with this change is that the caller may be trying to right size a String. So instead, we should just better document the behavior of `capacity:`.
2024-06-09Correct typo [ci skip]Sampat Badhe
2024-06-09[Bug #20566] Mention out-of-range argument cases in `String#<<`Nobuyoshi Nakada
Also [Bug #18973].
2024-06-07[DOC] document line continuation.Tanaka Akira
Document details of escape sequences including line continuation. [Bug #20518]
2024-06-04[DOC] Exceptions doc (#10865)Burdette Lamar
2024-06-04Removed trailing spaces.Hiroshi SHIBATA
2024-06-04Sync strscan HEAD again.Hiroshi SHIBATA
https://github.com/ruby/strscan/pull/99 split document with multi-byte chars.
2024-06-03fix typos.Tanaka Akira
2024-06-03[DOC] percent literals can be nested.Tanaka Akira
2024-06-02[DOC] building_ruby: Move the caution to a footnoteNobuyoshi Nakada
2024-06-02[DOC] building_ruby: External library linksNobuyoshi Nakada
- `OpenSSL` here is not the class. - libexecinfo on FreeBSD is present in the base system of all supported releases, since 2017.
2024-06-02[DOC] building_ruby: Refine linksNobuyoshi Nakada
Get rid of using ambiguous demonstratives as link anchors, for the accessibility's sake.
2024-06-02[DOC] building_ruby: Fold long linesNobuyoshi Nakada
2024-06-02[DOC] Caution about old GNU makeNobuyoshi Nakada
2024-05-30Revert "[ruby/strscan] Doc for StringScanner"Hiroshi SHIBATA
This reverts commit 974ed1408c516d1e8f992f0b304e2de6f8bd5c1f.
2024-05-30Revert "Fix reference path for strscan documentation"Hiroshi SHIBATA
This reverts commit 1fa93fb9488a32018101689fd727965fd5874eb5.
2024-05-30Fix reference path for strscan documentationHiroshi SHIBATA
2024-05-30[ruby/strscan] Doc for StringScannerBurdette Lamar
(https://github.com/ruby/strscan/pull/96) #peek_byte and #scan_byte not updated (not available in my repo -- sorry). --------- https://github.com/ruby/strscan/commit/0123da7352 Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
2024-05-14[DOC] Fix typo in example code for `String#encode` methodAlexander Ross
The example code in the documentation for the `String#encode` method has a typo in the `fallback` option. The example code uses `h` as the fallback option, but it should use `hash` instead to match the variable name in the example code.
2024-05-12[Bug #20482] [DOC] Clarify about pattern maching guard clauseNobuyoshi Nakada
Guard clauses can only be used in `case` pattern matching statements, not in `=>`/`in` operators.
2024-05-10Update ASAN docs to refer to Clang 18's releaseKJ Tsanaktsidis
Clang 18 has the bugfix we need, so we no longer need to tell people to compile Clang from source.
2024-04-26[DOC] Fix a typo in globals.rdoc Diego Henrique
Noticed this small type while reading the docs.
2024-04-26[DOC] Caveat about "allocate then wrap"Nobuyoshi Nakada