mirror/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-01-27 12:34:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
96,336 Commits 29 Branches 1,183 Tags
Commit Graph

1730 Commits

Author SHA1 Message Date
Nobuyoshi Nakada
d375bcc965
[DOC] Escape capitalized word "data" not to be linked unexpectedly 2025-12-25 11:56:41 +09:00
Nobuyoshi Nakada
b908306f99 [DOC] Reword "Regular Expression" to "Matched Data" 
`$~` and its accessors are related to regular expressions, but are not
themselves.
 2025-12-25 11:49:32 +09:00
NARUSE, Yui
285e22edc5 Revert "Add link to Ruby options doc in help text" 
This reverts commit 31ff07ed1eb05d01f7da3c017d542137a3db1e94.

* Don't add a test which only runs on production release
  * https://github.com/ruby/actions/actions/runs/20486784889/job/58870959976
* Don't add a new line to `ruby --help`
  * https://github.com/ruby/ruby/pull/14142#issuecomment-3689829564
 2025-12-24 22:55:44 +09:00
Burdette Lamar
ab683d56bc
[DOC] Cross-links between Japanese and English pages (#15705) 
* [DOC] Cross-links between Japanese and English pages
 2025-12-23 20:46:57 -06:00
Nobuyoshi Nakada
688c1f6c5e [DOC] Reword "Pattern Matching" to "Regular Expression" 
In ruby, since 3.1 at least, the words "Pattern Matching" should refer
the syntax.
 2025-12-24 10:46:58 +09:00
Steve
e2a58c45b1 [DOC] Fix minor typo in signals.rdoc 2025-12-24 10:39:49 +09:00
Victor Shepelev
d7d1109099
Describe base code layout rules (#15696) 
* Describe base code layout rules

* Enhance optional keyword explanation

* Change the logical operators description
 2025-12-23 19:09:41 +02:00
Jeremy Evans
d879f9f696 [DOC] Fix example in Ruby::Box documentation 2025-12-23 09:02:25 +01:00
Burdette Lamar
e69f41a0a8
[DOC] Languages in Examples (#15697) 
* [DOC] Languages in Examples

* Update doc/contributing/documentation_guide.md

Co-authored-by: Jeremy Evans <code@jeremyevans.net>

* Update doc/contributing/documentation_guide.md

Co-authored-by: Jeremy Evans <code@jeremyevans.net>

---------

Co-authored-by: Jeremy Evans <code@jeremyevans.net>
 2025-12-22 16:52:52 -06:00
Nobuyoshi Nakada
2191768980
[DOC] Refine packed_data.rdoc 
* Escape unexpected links
* Remove unnecessary path name from in-file reference
 2025-12-22 14:58:51 +09:00
Luke Gruber
d0ec60dc7b
More doc improvements to ractor.md (#15676) 
[DOC] More doc improvements to ractor.md
 2025-12-21 13:26:10 -05:00
Nobuyoshi Nakada
1bc2a91589
[DOC] Align tables in globals.md 
* Align "Contains" column in "Streams" table
* Align some columns vertically
* Remove a duplicate `$-a` description
 2025-12-21 11:31:36 +09:00
Luke Gruber
3fee7dd90d
Small improvements to doc/language/ractor.md (#15588) 
[DOC] Improvements to doc/language/ractor.md
 2025-12-20 15:28:04 -05:00
Burdette Lamar
5cdda61d00
[DOC] Enhancements for globals.md (#15545) 
* [DOC] Enhancements for globals.md
 2025-12-20 09:26:02 -06:00
Victor Shepelev
ec4ca91319
Small documentation adjustments for new/updated features (#15634) 
* Document Range#to_set

* Update Thread#raise and Fiber#raise signatures and docs

* Add reference to String#strip to character_selectors.rdoc

* Update *nil docs when calling methods

* Enhance Array#find and #rfind docs

* Add a notice to Kernel#raise about cause:
 2025-12-20 13:07:38 +02:00
Nobuyoshi Nakada
77c3a9e447 Revert pack/unpack support for LEB128 
https://bugs.ruby-lang.org/issues/21785#note-10
> It is too late to introduce it in Ruby 4.0, let's aim for 4.1.

This reverts commits:

* d0b72429a93e54f1f956b4aedfc25c57dc7001aa
  Add support for signed and unsigned LEB128 to pack/unpack.

* 68a900e30b4ca1537d7975c3a619fd94fca7b084
  add news for pack / unpack directives
 2025-12-20 16:59:51 +09:00
Satoshi Tagomori
49f9c9bff2 Box: [DOC] Uodate the name from Namespace 2025-12-20 16:18:33 +09:00
Alan Wu
bb0637a92f ZJIT: [DOC] Fix link to in-repo file. Mention GNU Make requirement 2025-12-19 21:27:01 -05:00
Nobuyoshi Nakada
f0472f2d49
[Feature #21785] [DOC] LEB128 support 2025-12-19 17:16:15 +09:00
BurdetteLamar
99b915944f [DOC] Russian strings should look Russian 2025-12-18 17:47:18 -05:00
Aaron Patterson
d0b72429a9 Add support for signed and unsigned LEB128 to pack/unpack. 
This commit adds a new pack format command `R` and `r` for unsigned and
signed LEB128 encoding.  The "r" mnemonic is because this is a
"vaRiable" length encoding scheme.

LEB128 is used in various formats including DWARF, WebAssembly, MQTT,
and Protobuf.

[Feature #21785]
 2025-12-18 14:42:47 -08:00
Max Bernstein
98cac1a75d
Point people to redmine on ZJIT docs (#15499) 
Fix https://github.com/Shopify/ruby/issues/900
 2025-12-15 19:10:04 -05:00
Peter Zhu
1e76b1f8b2 [DOC] Remove doc/reline 
Reline has been moved to a bundled gem, so we don't need the docs anymore.
 2025-12-14 21:01:15 -05:00
Alan Wu
c092c294d4 ZJIT: [DOC] Mention build prerequisites 2025-12-11 15:45:56 -05:00
Burdette Lamar
6ec5c5f1c8
[ruby/stringio] [DOC] Doc for StringIO.size 
(https://github.com/ruby/stringio/pull/171)

https://github.com/ruby/stringio/commit/95a111017a
 2025-12-10 15:18:21 +09:00
Burdette Lamar
b4a1f17058
[ruby/stringio] [DOC] Tweaks for StringIO#each_line 
(https://github.com/ruby/stringio/pull/165)

Adds to "Position":  pos inside a character.

Makes a couple of minor corrections.

---------

https://github.com/ruby/stringio/commit/ff332abafa

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
 2025-12-10 15:18:15 +09:00
Burdette Lamar
5bc65db555
[ruby/stringio] [DOC] Tweaks for StringIO#gets 
(https://github.com/ruby/stringio/pull/190)

https://github.com/ruby/stringio/commit/77209fac20
 2025-12-10 15:17:09 +09:00
Burdette Lamar
f623fcc7d0
[ruby/stringio] [DOC] Tweaks for StringIO.getbyte 
(https://github.com/ruby/stringio/pull/188)

https://github.com/ruby/stringio/commit/66360ee5f1
 2025-12-10 15:16:53 +09:00
BurdetteLamar
668fe01182
[ruby/stringio] [DOC] Fix link 
https://github.com/ruby/stringio/commit/e2d24ae8d7
 2025-12-10 15:16:39 +09:00
Burdette Lamar
842f91aec0
[ruby/stringio] [DOC] Tweaks for StringIO#getc 
(https://github.com/ruby/stringio/pull/189)

https://github.com/ruby/stringio/commit/e3d16d30ed
 2025-12-10 15:13:28 +09:00
Nobuyoshi Nakada
1933f1291a
[DOC] Clear one of known issues of Ruby Box 2025-12-09 23:44:06 +09:00
Satoshi Tagomori
e8568bbcf2 [DOC] Update Ruby Box documents (known issues) 2025-12-09 23:08:33 +09:00
Satoshi Tagomori
5ae2bd240f [DOC] Add Ruby::Box on NEWS 2025-12-09 21:36:26 +09:00
Max Bernstein
fd45496f91
Update ZJIT docs (#15449) 2025-12-08 16:59:27 +00:00
Peter Zhu
fb80f84fc7 [DOC] Fix formatting in docs for String#[]= 2025-12-06 17:59:50 -08:00
Nobuyoshi Nakada
d490247df2
[DOC] Link global variables to command line options 2025-12-06 14:39:47 +09:00
Burdette Lamar
21f9a647fb [ruby/stringio] [DOC] Class doc for StringIO 
(https://github.com/ruby/stringio/pull/178)

https://github.com/ruby/stringio/commit/6449251678
 2025-12-05 22:08:29 -05:00
BurdetteLamar
bd64cf00a2 [DOC] Tweaks for String#capitalize 2025-12-05 19:05:55 -08:00
BurdetteLamar
2491a504ff [DOC] Tweaks for String#downcase 2025-12-05 19:05:18 -08:00
BurdetteLamar
e5e4175dbd [DOC] Tweaks for String#upcase 2025-12-05 19:04:59 -08:00
BurdetteLamar
da2c67388a [DOC] Tweaks for String#swapcase 2025-12-05 19:04:23 -08:00
BurdetteLamar
bbef73b2ff [DOC] Better multibyte-character data 2025-12-05 19:03:22 -08:00
Nobuyoshi Nakada
1cad20e2d5
[DOC] Describe $F 
This variation is used when `-a` option is given.
 2025-12-05 16:47:39 +09:00
Nobuyoshi Nakada
1e7373ef30
[DOC] Describe the global variables set by command line options 
These variables are set by command line options, but it is deprecated
to assign them any value other than nil in ruby code.
 2025-12-05 16:31:36 +09:00
Nobuyoshi Nakada
b35aff5813
[DOC] Centerize Variable, English, and Constant columns 2025-12-05 16:14:15 +09:00
Koichi Sasada
2aaea665bb fix typo s/sharable/shareable/ 2025-12-05 03:10:50 +09:00
Nobuyoshi Nakada
8099e9d2d1
[DOC] Fix a macro name 2025-12-04 18:08:23 +09:00
Burdette Lamar
6e723bee45
[DOC] About Float Imprecision (#15293) 2025-12-02 21:41:21 -05:00
Yuki Kurihara
a63147eed1 [ruby/strscan] [DOC] Avoid being interpreted as a link 
(https://github.com/ruby/strscan/pull/180)

Since `[](n)` is being interpreted as a Markdown link, it cannot be
displayed as a method call.
I have corrected this by escaping the brackets so that they are
interpreted as strings rather than links.

### Before

ri

```
    #{}[n]     |   <tt>n</tt>th captured substring.    |       +nil+.
```

html

<img width="424" height="217" alt="image"
src="https://github.com/user-attachments/assets/b45601ab-ed1c-4b82-b112-325f12bde197"
/>

### After

ri

```
    #[](n)     |   <tt>n</tt>th captured substring.    |       +nil+.
```

html

<img width="489" height="217" alt="image"
src="https://github.com/user-attachments/assets/1212c147-42a5-4f62-8667-a279ccff67a3"
/>

https://github.com/ruby/strscan/commit/b3d56867fd
 2025-12-02 22:24:29 +00:00
Benoit Daloze
e515fa7ab1 ZJIT: Improve documentation and make it easy to generate the types graph 2025-12-02 10:35:16 +01:00