Commit graph

1581 commits

Author SHA1 Message Date
Hiroshi SHIBATA
1bd029b1ea
Note the detailed version of Windows SDK 2025-04-11 10:55:31 +09:00
Hiroshi SHIBATA
af69421c91
Added instruction for MSYS2 without RubyInstaller-Devkit 2025-04-11 10:49:26 +09:00
Nobuyoshi Nakada
8003a06854
[DOC] Use slashes in mingw confiure examples
To show that mingw `sh` expects forward slashes as path separators, not
backslashes, configure in another directory than the source directory.
2025-04-10 17:39:56 +09:00
Hiroshi SHIBATA
8ab517698a
sed is not requirement now 2025-04-09 10:31:33 +09:00
Herwin
b8e2bec914 Grammar fix in doc/exceptions.md: there => they're 2025-04-03 10:14:58 +09:00
Burdette Lamar
765918d283
[DOC] Tweaks for docs about contributing (#13012) 2025-03-31 14:48:23 -04:00
Joshua Young
99503ab975 Escape Binding reference in pattern matching docs 2025-03-21 10:36:13 +09:00
Mari Imaizumi
e63c516046 [Feature #19908] Update Unicode headers to 15.1.0 2025-03-18 21:18:12 +09:00
Yutaro Ohno
482b5307f2 [DOC] Correct output in calling_methods.rdoc 2025-03-13 13:43:36 +09:00
Nobuyoshi Nakada
b8af9325c0
[DOC] Discourage use of USERDEF 2025-03-12 18:42:39 +09:00
Nobuyoshi Nakada
45e8dc1e85 [ruby/optparse] [DOC] Mention about post-check
e1957d7392
2025-03-10 09:55:29 +00:00
Nobuyoshi Nakada
9de9cb53c0 [ruby/optparse] [DOC] Update documents to use single quotes instead of backqoutes
5e71a70cb5
2025-03-10 07:56:44 +00:00
Nobuyoshi Nakada
4a67ef09cc
[Feature #21116] Extract RJIT as a third-party gem 2025-02-13 18:01:03 +09:00
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.

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)

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/

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

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