summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2025-05-22Sync RDoc 6.14.0Stan Lo
2024-12-24[DOC] RegExp: The Graph property includes some control charactersAlan Wu
The behavior of this is a carry-over from Oniguruma: https://github.com/kkos/oniguruma/blob/5eaee9f5f8f674aff4875c2b35db00758fa349d6/doc/RE#L246 The previous phrasing was inaccurate since it's fair to construe e.g. Zero Width Joiner as a control character. Reported-by: https://github.com/ruby/ruby/pull/12294
2024-12-24[DOC] Adjust documentation related to backtraces (#12420)Victor Shepelev
Notes: Merged-By: zverok <zverok.offline@gmail.com>
2024-12-22[DOC] Update about optional dump flagsNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12430
2024-12-22s/Punctation/Punctuation/ydah
Notes: Merged: https://github.com/ruby/ruby/pull/12426
2024-12-22s/backslashs/backslashes/ydah
Notes: Merged: https://github.com/ruby/ruby/pull/12426
2024-12-20[DOC] Refresh standard libraries page (#12404)Stan Lo
* Migrate standard library doc page to markdown * Improve libraries listing and link to source code * Fix grammar and improve phrasing Co-authored-by: Jeremy Evans <code@jeremyevans.net> Notes: Merged-By: jeremyevans <code@jeremyevans.net>
2024-12-18[DOC] Fix output examples containing old Hash#inspect formattomoya ishida
The inspect format was intentionally changed as an outcome of [Bug #20433] [ruby-core:118668], but some documentation update was missing, as [Bug #20962] pointed out. Update some output examples that clearly use Hash#inspect. Notes: Merged: https://github.com/ruby/ruby/pull/12384 Merged-By: XrXr
2024-12-17[Bug #20951] [DOC] UTC offset in `utc_to_local`Nobuyoshi Nakada
2024-12-16Add back summary table for pack/unpack directives (#12349)Benoit Daloze
* Add back summary table for pack/unpack directives * This concise summary is very helpful e.g. to find the right Integer directive, and is much better at getting an overview than very long text. * From https://github.com/ruby/ruby/pull/6567 * I merged the tables for Array#pack and String#unpack, there were almost the same except for String and Misc. directives. * Tune up the tabular data and moves it to the top. Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com> Co-authored-by: Stan Lo <stan001212@gmail.com> Notes: Merged-By: eregon <eregontp@gmail.com>
2024-12-16[ruby/strscan] [DOC] Add syntax highlighting to MarkDown code blocksAlexander Momchilov
(https://github.com/ruby/strscan/pull/126) Split off from https://github.com/ruby/ruby/pull/12322 https://github.com/ruby/strscan/commit/9bee37e0f5
2024-12-15[DOC] Adjust argument unpacking docs and document **nil (#12228)Victor Shepelev
[DOC] Rewrite argument unpacking docs and document **nil Notes: Merged-By: zverok <zverok.offline@gmail.com>
2024-12-15[Bug #20951] [DOC] About UTC offset calculation after `utc_to_local`Nobuyoshi Nakada
2024-12-15Add date to doc/.documentStan Lo
Otherwise, dozens of links to date/calendars.rdoc will still be broken after https://github.com/ruby/date/pull/113 Notes: Merged: https://github.com/ruby/ruby/pull/12346
2024-12-15[ruby/date] Fix broken rdoc-ref to the calendar pageStan Lo
https://github.com/ruby/date/commit/cb52e64be1
2024-12-14[ruby/rdoc] Fix dead links in the markup reference pageStan Lo
(https://github.com/ruby/rdoc/pull/1242) https://github.com/ruby/rdoc/commit/d1cb9dc3c4
2024-12-13[DOC] Move the comma outside the `<tt>` tagNobuyoshi Nakada
2024-12-12Improve "Building Ruby" docs (#12320)Alexander Momchilov
* Clarify “Building Ruby” docs * Fix test examples to work from `build` dir * Clarify “Testing Ruby” examples with real examples All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory. Also, let’s use a consistent example throughout, for greater clarity. * Improve examples to use `-v` flag in-context This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test. * Other readability improvements * Clarify `make` implementation support
2024-12-12[DOC] Improve formatting in Markdown files (#12322)Alexander Momchilov
* Fix WASM bullet/code indentation * Use `console` code highlighting where appropriate … which handles the prefix `$` correctly. * Migrate feature proposal template to MarkDown * Set language on code blocks
2024-12-10YJIT: add MPLR talk link. Encourage users to use --yjit-mem-size (#12305)Maxime Chevalier-Boisvert
* Add MPLR talk. Encourage users to use --yjit-mem-size. * Improve text Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2024-12-10[ruby/strscan] [DOC] doc/strscan/strscan.md - update Matcher MethodsNAITOH Jun
(https://github.com/ruby/strscan/pull/123) Added support for string pattern type in https://github.com/ruby/strscan/pull/106. And fix Success Return content. https://github.com/ruby/strscan/commit/6a5acde674
2024-12-06[DOC] New homepage for docs.ruby-lang.org/en (#12227)Stan Lo
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2024-12-05[ruby/rdoc] Deprecate `main` and `title` directivesStan Lo
(https://github.com/ruby/rdoc/pull/1218) * Deprecate :main: directive * Deprecate :title: direcive * Update documentation * Remove :main: directive's usage * Update test cases * Add '.rdoc_options' to suggested alternatives https://github.com/ruby/rdoc/commit/e2d4ac9dad
2024-12-03Fixed wrong instruction with mswin buildHiroshi SHIBATA
2024-11-29Remove document file needless for ruby coreNobuyoshi Nakada
This reverts commit 743a31d639d4c96827b1b17f59c829c1ec31abc3, "[ruby/date] [DOC] Make document coverage 100%". This file is only for rdoc coverage in the date gem, and useless when the built-in Time is documented. Notes: Merged: https://github.com/ruby/ruby/pull/12206
2024-11-27[DOC] Add more links to maintainersNobuyoshi Nakada
2024-11-25Use footnote links insteadStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-25Update maintainer GH handles and add links when possibleStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-25Escape Module in the headerStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-25Add new lines after headersStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-25Update RDoc's maintainers listStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-20[ruby/date] [DOC] Make document coverage 100%Nobuyoshi Nakada
https://github.com/ruby/date/commit/269392b775
2024-11-19[DOC] Fix the default `limit` of String#splitKouhei Yanagita
We can't pass `nil` as the second parameter of `String#split`. Therefore, descriptions like "if limit is nil, ..." are not appropriate. Notes: Merged: https://github.com/ruby/ruby/pull/12109
2024-11-12[DOC] `--with-opt-dir` options and `CONFIGURE_ARGS`Nobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12059
2024-10-29[ruby/strscan] [DOC] doc/strscan/strscan.md - fix triple backtickMSP-Greg
(https://github.com/ruby/strscan/pull/112) See current doc, search for '## Target Substring', notice the backtick that isn't visible to the GitHub md parser. https://github.com/ruby/strscan/blob/843e931d134b0a8f0284296250454374e3f8a6aa/doc/strscan/strscan.md Fixed in the PR, see: https://github.com/MSP-Greg/strscan/blob/00-strscan.md/doc/strscan/strscan.md https://github.com/ruby/strscan/commit/041b15df4c
2024-10-28[DOC] Tweaks for windows.mdNobuyoshi Nakada
2024-10-28Win32: [DOC] Update about program name configurationsNobuyoshi Nakada
2024-10-28Win32: [DOC] Mention `vcvarall*.bat`Nobuyoshi Nakada
2024-10-28Win32: [DOC] No extlibs file, no patch is neededNobuyoshi Nakada
2024-10-17YJIT: Add compilation log (#11818)Kevin Menard
* YJIT: Add `--yjit-compilation-log` flag to print out the compilation log at exit. * YJIT: Add an option to enable the compilation log at runtime. * YJIT: Fix a typo in the `IseqPayload` docs. * YJIT: Add stubs for getting the YJIT compilation log in memory. * YJIT: Add a compilation log based on a circular buffer to cap the log size. * YJIT: Allow specifying either a file or directory name for the YJIT compilation log. The compilation log will be populated as compilation events occur. If a directory is supplied, then a filename based on the PID will be used as the write target. If a file name is supplied instead, the log will be written to that file. * YJIT: Add JIT compilation of C function substitutions to the compilation log. * YJIT: Add compilation events to the circular buffer even if output is sent to a file. Previously, the two modes were treated as being exclusive of one another. However, it could be beneficial to log all events to a file while also allowing for direct access of the last N events via `RubyVM::YJIT.compilation_log`. * YJIT: Make timestamps the first element in the YJIT compilation log tuple. * YJIT: Stream log to stderr if `--yjit-compilation-log` is supplied without an argument. * YJIT: Eagerly compute compilation log messages to avoid hanging on to references that may GC. * YJIT: Log all compiled blocks, not just the method entry points. * YJIT: Remove all compilation events other than block compilation to slim down the log. * YJIT: Replace circular buffer iterator with a consuming loop. * YJIT: Support `--yjit-compilation-log=quiet` as a way to activate the in-memory log without printing it. Co-authored-by: Randy Stauner <randy.stauner@shopify.com> * YJIT: Promote the compilation log to being the one YJIT log. Co-authored-by: Randy Stauner <randy.stauner@shopify.com> * Update doc/yjit/yjit.md * Update doc/yjit/yjit.md --------- Co-authored-by: Randy Stauner <randy.stauner@shopify.com> Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com> Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2024-10-17Update maintainers of PrismKevin Newton
Notes: Merged: https://github.com/ruby/ruby/pull/11909
2024-10-11Fix spellingJohn Bampton
Notes: Merged: https://github.com/ruby/ruby/pull/11882 Merged-By: XrXr
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
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-16 10:26:46 +0000