1468 Commits

Author SHA1 Message Date
Burdette Lamar
b4bf3ed130
[DOC] Adds section "Hash Inclusion" (#12634) 2025-02-10 14:32:25 -05:00
Daisuke Aritomo
15b77a09a7 [DOC] ractor.md: Remove link to Complex class 2025-02-06 09:49:23 +09:00
Hiroshi SHIBATA
b50360e08b Update fiddle entries under the doc directory 2025-02-05 07:36:59 +09:00
Edouard CHIN
366462bd46 - Add a mention to git 2.32 in the building ruby documentation:
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: 7070b1b196/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. 7070b1b196/tool/lib/vcs.rb (L549)
2025-01-31 11:52:57 +09:00
Hiroshi SHIBATA
5422c0f7f8 Update irb and reline, readline entries 2025-01-24 15:46:46 +09:00
Hiroshi SHIBATA
abde86afe8
Update win32ole entries under the doc directory 2025-01-23 16:09:48 +09:00
Nobuyoshi Nakada
e65986c9bc
[DOC] Add reference from global variables to equivalent MatchData
c.f. #21040
2025-01-16 14:21:37 +09:00
Nobuyoshi Nakada
32cb4b204d
[DOC] Link to MarkupReference directly 2025-01-16 14:03:45 +09:00
Hiroshi SHIBATA
fe2bc77830
Update documents with the latest bundled gems 2025-01-15 17:13:16 +09:00
Jean Boussier
e2f1f7c567 [Doc] Encourage use of encoding constants
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.
2025-01-12 11:48:01 +01:00
David Rodríguez
cde065c32c
Clarify documentation for encoding of String.new without arguments
[Bug #21025]
2025-01-10 17:36:51 -05:00
Hiroshi SHIBATA
574bfd2845 Update documents for ostruct 2025-01-08 17:12:19 +09:00
Nobuyoshi Nakada
e9593eb967
[DOC] Fix an error example
`%q{c}` after another string literal is parsed as RHS of modulo, `q`
method call with a block.
2025-01-07 09:56:54 +09:00
Earlopain
89c505dc47 Move string escape sequence documention further down
If someone looks at documention for strings,
I don't think escape sequences is what they look
for in majority of the cases.
2025-01-07 07:56:48 +09:00
Earlopain
b0d291ec83 Fix link to strings in literals.rdoc
Since 5e1001f754, the string link is broken

Instead of changing the anchor reference, I changed the header directly,
to keep in line with other titles
2025-01-07 07:56:48 +09:00
Stan Lo
e45fca1372 [ruby/rdoc] [DOC] Remove unnecessary rdoc-ref missing example
(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-05 12:41:53 +00:00
Stan Lo
f1096c6ad4
Remove and stop syncing IRB documentation (#12416)
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.
2025-01-02 23:32:28 +09:00
Nobuyoshi Nakada
e433e6515e
[DOC] Exclude 'Class' and 'Module' from RDoc's autolinking 2025-01-02 12:36:06 +09:00
Nobuyoshi Nakada
b4ec22fe6c
[DOC] Exclude 'Method' from RDoc's autolinking 2025-01-02 12:23:49 +09:00
Stan Lo
2dd4801e9c Update 'Set's references in docs
- When linking to 'Set', we should use `rdoc-ref:Set` explicitly.
- "Set"'s normal usages don't need to be escaped anymore.
2025-01-02 11:05:33 +09:00
Nobuyoshi Nakada
63b141ef21 [ruby/rdoc] Documentation for #1240
(https://github.com/ruby/rdoc/pull/1263)

https://github.com/ruby/rdoc/commit/5dfccda4c0
2024-12-31 12:16:50 +00:00
Yudai Takada
b7690c58b9 [ruby/strscan] [DOC] Fix typo in documentation
(https://github.com/ruby/strscan/pull/129)

s/begining/beginning/

https://github.com/ruby/strscan/commit/734b823463
2024-12-26 10:27:24 +09:00
Hiroshi SHIBATA
7f738bb5d7
Restore Ruby 3.4 NEWS.md again 2024-12-25 18:18:26 +09:00
Yukihiro "Matz" Matsumoto
873f6ca382
[DOC] Flush NEWS.md 2024-12-25 18:15:16 +09:00
Hiroshi SHIBATA
b5825a1f5c
Restore Ruby 3.4 NEWS.md 2024-12-25 17:25:11 +09:00
Alan Wu
468b7af67e [DOC] RegExp: The Graph property includes some control characters
The behavior of this is a carry-over from Oniguruma:
  5eaee9f5f8/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 15:40:57 -05:00
Victor Shepelev
58460b4dbd
[DOC] Adjust documentation related to backtraces (#12420) 2024-12-24 20:49:55 +02:00
Nobuyoshi Nakada
0ea0b1a15d
[DOC] Update about optional dump flags 2024-12-22 23:42:40 +09:00
ydah
cd8ad9634d s/Punctation/Punctuation/ 2024-12-22 18:09:02 +09:00
ydah
b8fe5550e7 s/backslashs/backslashes/ 2024-12-22 18:09:02 +09:00
Stan Lo
5d1fde06d4
[DOC] Refresh standard libraries page (#12404)
* 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>
2024-12-20 10:57:02 -08:00
tomoya ishida
477c505ac0
[DOC] Fix output examples containing old Hash#inspect format
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.
2024-12-18 12:08:15 -05:00
Nobuyoshi Nakada
b6973e4ffc
[Bug #20951] [DOC] UTC offset in utc_to_local 2024-12-17 10:10:26 +09:00
Benoit Daloze
b72e8ab816
Add back summary table for pack/unpack directives (#12349)
* 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>
2024-12-16 22:44:34 +01:00
Alexander Momchilov
41e24c2f3e
[ruby/strscan] [DOC] Add syntax highlighting to MarkDown code blocks
(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-16 10:10:34 +09:00
Victor Shepelev
1ac28224e0
[DOC] Adjust argument unpacking docs and document **nil (#12228)
[DOC] Rewrite argument unpacking docs and document **nil
2024-12-15 21:53:39 +02:00
Nobuyoshi Nakada
966458199d
[Bug #20951] [DOC] About UTC offset calculation after utc_to_local 2024-12-15 16:57:24 +09:00
Stan Lo
e08e168a57 Add date to doc/.document
Otherwise, dozens of links to date/calendars.rdoc will still be broken
after https://github.com/ruby/date/pull/113
2024-12-15 15:30:45 +09:00
Stan Lo
6d00dee30a [ruby/date] Fix broken rdoc-ref to the calendar page
https://github.com/ruby/date/commit/cb52e64be1
2024-12-15 06:20:10 +00:00
Stan Lo
792275e5f0 [ruby/rdoc] Fix dead links in the markup reference page
(https://github.com/ruby/rdoc/pull/1242)

https://github.com/ruby/rdoc/commit/d1cb9dc3c4
2024-12-14 12:12:45 +00:00
Nobuyoshi Nakada
1fd2437b63
[DOC] Move the comma outside the <tt> tag 2024-12-13 11:59:58 +09:00
Alexander Momchilov
8cc47c9050
Improve "Building Ruby" docs (#12320)
* 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 17:55:23 -08:00
Alexander Momchilov
0ea5c13bc6
[DOC] Improve formatting in Markdown files (#12322)
* 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-12 17:49:45 -08:00
Maxime Chevalier-Boisvert
c71f7faaa9
YJIT: add MPLR talk link. Encourage users to use --yjit-mem-size (#12305)
* Add MPLR talk. Encourage users to use --yjit-mem-size.

* Improve text
2024-12-10 18:16:24 -05:00
NAITOH Jun
cb8f186205
[ruby/strscan] [DOC] doc/strscan/strscan.md - update Matcher Methods
(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-10 11:30:19 +09:00
Stan Lo
8ad6860ff7
[DOC] New homepage for docs.ruby-lang.org/en (#12227) 2024-12-06 13:51:08 -05:00
Stan Lo
2ecd2fe0ed [ruby/rdoc] Deprecate main and title directives
(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-05 11:36:34 +00:00
Hiroshi SHIBATA
b4481a6b8b
Fixed wrong instruction with mswin build 2024-12-03 17:43:56 +09:00
Nobuyoshi Nakada
a1500eefdb
Remove document file needless for ruby core
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.
2024-11-29 09:13:51 +09:00
Nobuyoshi Nakada
87fc9f4a70
[DOC] Add more links to maintainers 2024-11-27 17:31:56 +09:00