summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2025-02-05Update fiddle entries under the doc directoryHiroshi SHIBATA
Notes: Merged: https://github.com/ruby/ruby/pull/12616
2025-01-31- Add a mention to git 2.32 in the building ruby documentation:Edouard CHIN
I had issues building Ruby as I was using git 2.30. The error was: > file2lastrev.rb: git rev-parse failed error: could not expand > include path '~/.gitcinclude' The default system git config includes paths making use of `$HOME`, but that env variable gets removed when building: https://github.com/ruby/ruby/blob/7070b1b1968f31f999636b42a1af872458cd5a81/tool/lib/vcs.rb#L546-L547 It works with git `>= 2.32` thanks to the `GIT_CONFIG_SYSTEM` feature which gets set to a Null IO in order to override the system gitconfig. https://github.com/ruby/ruby/blob/7070b1b1968f31f999636b42a1af872458cd5a81/tool/lib/vcs.rb#L549 Notes: Merged: https://github.com/ruby/ruby/pull/12611
2025-01-24Update irb and reline, readline entriesHiroshi SHIBATA
Notes: Merged: https://github.com/ruby/ruby/pull/12624
2025-01-23Update win32ole entries under the doc directoryHiroshi SHIBATA
2025-01-16[DOC] Add reference from global variables to equivalent MatchDataNobuyoshi Nakada
c.f. #21040 Notes: Merged: https://github.com/ruby/ruby/pull/12587
2025-01-16[DOC] Link to MarkupReference directlyNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12586
2025-01-15Update documents with the latest bundled gemsHiroshi SHIBATA
2025-01-12[Doc] Encourage use of encoding constantsJean Boussier
Lots of documentation examples still use encoding APIs with encoding names rather than encoding constants. I think it would be preferable to direct users toward constants as it can help with auto-completion, static analysis and such. Notes: Merged: https://github.com/ruby/ruby/pull/12552
2025-01-10Clarify documentation for encoding of `String.new` without argumentsDavid Rodríguez
[Bug #21025] Notes: Merged: https://github.com/ruby/ruby/pull/12548 Merged-By: XrXr
2025-01-08Update documents for ostructHiroshi SHIBATA
Notes: Merged: https://github.com/ruby/ruby/pull/12531
2025-01-07[DOC] Fix an error exampleNobuyoshi Nakada
`%q{c}` after another string literal is parsed as RHS of modulo, `q` method call with a block.
2025-01-07Move string escape sequence documention further downEarlopain
If someone looks at documention for strings, I don't think escape sequences is what they look for in majority of the cases. Notes: Merged: https://github.com/ruby/ruby/pull/12318
2025-01-07Fix link to strings in literals.rdocEarlopain
Since https://github.com/ruby/ruby/commit/5e1001f754b34e1f0cc67563512c6036b6eb75ab, the string link is broken Instead of changing the anchor reference, I changed the header directly, to keep in line with other titles Notes: Merged: https://github.com/ruby/ruby/pull/12318
2025-01-05[ruby/rdoc] [DOC] Remove unnecessary rdoc-ref missing exampleStan Lo
(https://github.com/ruby/rdoc/pull/1271) We don't actually need to link to the missing item to show the non-linked result. https://github.com/ruby/rdoc/commit/a7b7e8fc55
2025-01-02Remove and stop syncing IRB documentation (#12416)Stan Lo
Follow-up to #12325 Since we're not generating IRB documentation, we don't need to sync its `doc/` folder and keep the previous content. Notes: Merged-By: tompng <[email protected]>
2025-01-02[DOC] Exclude 'Class' and 'Module' from RDoc's autolinkingNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12496
2025-01-02[DOC] Exclude 'Method' from RDoc's autolinkingNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12496
2025-01-02Update 'Set's references in docsStan Lo
- When linking to 'Set', we should use `rdoc-ref:Set` explicitly. - "Set"'s normal usages don't need to be escaped anymore. Notes: Merged: https://github.com/ruby/ruby/pull/12491
2024-12-31[ruby/rdoc] Documentation for #1240Nobuyoshi Nakada
(https://github.com/ruby/rdoc/pull/1263) https://github.com/ruby/rdoc/commit/5dfccda4c0
2024-12-26[ruby/strscan] [DOC] Fix typo in documentationYudai Takada
(https://github.com/ruby/strscan/pull/129) s/begining/beginning/ https://github.com/ruby/strscan/commit/734b823463 Notes: Merged: https://github.com/ruby/ruby/pull/12469
2024-12-25Restore Ruby 3.4 NEWS.md againHiroshi SHIBATA
2024-12-25[DOC] Flush NEWS.mdYukihiro "Matz" Matsumoto
2024-12-25Restore Ruby 3.4 NEWS.mdHiroshi SHIBATA
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 <[email protected]>
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 <[email protected]> Notes: Merged-By: jeremyevans <[email protected]>
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 <[email protected]> Co-authored-by: Stan Lo <[email protected]> Notes: Merged-By: eregon <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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