BurdetteLamar
b9902c94a3
Adds remarks about returned Enumerator
2024-08-23 16:21:40 -04:00
Burdette Lamar
f5579c9278
[DOC] Include keywords.rdoc in doc/syntax/ ( #11414 )
2024-08-21 12:06:48 -04:00
Neil Carvalho
4dbf386ca2
[DOC] Add `$;` to the list of deprecated global variables
2024-08-17 19:36:22 +09:00
Takashi Kokubun
77ffdfe79f
YJIT: Allow tracing fallback counters ( #11347 )
...
* YJIT: Allow tracing fallback counters
* Update yjit.md about --yjit-trace-exits=counter
2024-08-08 16:13:16 -07:00
BurdetteLamar
e008f0553d
[DOC] Add remark about in-brief for method doc
2024-08-08 16:08:47 -04:00
Burdette Lamar
f5d193d525
[DOC] Adds "Further Considerations" to documentation_guide.md ( #11281 )
2024-07-31 16:09:15 -04:00
Burdette Lamar
63bdf2d725
[ruby/rdoc] [DOC] Mods about markup formats
...
(https://github.com/ruby/rdoc/pull/1143 )
https://github.com/ruby/rdoc/commit/011de3f2fd
2024-07-29 13:16:18 +00:00
BurdetteLamar
df1cc04301
Add remark about call-seq
2024-07-29 09:15:19 -04:00
Shugo Maeda
e048a073a3
Add MatchData#bytebegin and MatchData#byteend
...
These methods return the byte-based offset of the beginning or end of the specified match.
[Feature #20576 ]
2024-07-16 14:48:06 +09:00
Maxime Chevalier-Boisvert
a58e3305ce
YJIT: remove doc/yjit/yjit_hacking.md ( #11153 )
...
Document is 3 years old and out of date
2024-07-11 19:17:40 +00:00
Maxime Chevalier-Boisvert
c0ad0c3e43
Update yjit.md, explain how to run a single test with test-all ( #11151 )
2024-07-11 17:02:01 +00:00
cdfzo
087b461c83
[DOC] Fix typo `with` -> `wish`
2024-07-07 13:09:42 +09:00
Alan Wu
e240fc9c3c
[DOC] yjit.md: Markdown fixes for RDoc
...
It now renders properly on both GitHub and with RDoc's darkfish theme.
2024-07-05 18:38:46 -04:00
Anatoly Busygin
c46af61bf1
[ruby/irb] fix typos in the `Index of Command-Line Options`
...
https://github.com/ruby/irb/commit/3512020f1c
2024-07-01 11:39:43 +09:00
Burdette Lamar
43d7db3828
[DOC] Doc for exceptions ( #11008 )
2024-06-26 13:31:40 -04:00
Hiroshi SHIBATA
b4503d7964
Mentioned new mswin tasks related with vcpkg
2024-06-26 14:45:24 +09:00
Hiroshi SHIBATA
514aa80563
Added git for requirements of Windows build
2024-06-26 14:45:24 +09:00
Jean Boussier
83f57ca3d2
String.new(capacity:) don't substract termlen
...
[Bug #20585 ]
This was changed in 36a06efdd9f0604093dccbaf96d4e2cb17874dc8 because
`String.new(1024)` would end up allocating `1025` bytes, but the problem
with this change is that the caller may be trying to right size a String.
So instead, we should just better document the behavior of `capacity:`.
2024-06-19 15:11:07 +02:00
Sampat Badhe
4dfd4e1d00
Correct typo [ci skip]
2024-06-09 21:01:35 +09:00
Nobuyoshi Nakada
dd8903fed7
[Bug #20566 ] Mention out-of-range argument cases in `String#<<`
...
Also [Bug #18973 ].
2024-06-09 10:11:06 +09:00
Tanaka Akira
5e1001f754
[DOC] document line continuation.
...
Document details of escape sequences including line continuation.
[Bug #20518 ]
2024-06-07 21:55:42 +09:00
Burdette Lamar
6b379b9b98
[DOC] Exceptions doc ( #10865 )
2024-06-04 13:50:42 -04:00
Hiroshi SHIBATA
8080cb7090
Removed trailing spaces.
2024-06-04 15:00:47 +09:00
Hiroshi SHIBATA
3eda59e975
Sync strscan HEAD again.
...
https://github.com/ruby/strscan/pull/99 split document with multi-byte
chars.
2024-06-04 12:40:08 +09:00
Tanaka Akira
61af722d4e
fix typos.
2024-06-03 14:37:32 +09:00
Tanaka Akira
ca2170e69f
[DOC] percent literals can be nested.
2024-06-03 12:24:55 +09:00
Nobuyoshi Nakada
1f8c45aa51
[DOC] building_ruby: Move the caution to a footnote
2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada
7e52e3e3f7
[DOC] building_ruby: External library links
...
- `OpenSSL` here is not the class.
- libexecinfo on FreeBSD is present in the base system of all
supported releases, since 2017.
2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada
457c6b4789
[DOC] building_ruby: Refine links
...
Get rid of using ambiguous demonstratives as link anchors, for the
accessibility's sake.
2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada
5980f14e88
[DOC] building_ruby: Fold long lines
2024-06-02 21:33:01 +09:00
Nobuyoshi Nakada
3eba84fba0
[DOC] Caution about old GNU make
2024-06-02 19:59:05 +09:00
Hiroshi SHIBATA
78bfde5d9f
Revert "[ruby/strscan] Doc for StringScanner"
...
This reverts commit 974ed1408c
.
2024-05-30 21:13:10 +09:00
Hiroshi SHIBATA
d70b0da482
Revert "Fix reference path for strscan documentation"
...
This reverts commit 1fa93fb948
.
2024-05-30 21:13:01 +09:00
Hiroshi SHIBATA
1fa93fb948
Fix reference path for strscan documentation
2024-05-30 14:29:25 +09:00
Burdette Lamar
974ed1408c
[ruby/strscan] Doc for StringScanner
...
(https://github.com/ruby/strscan/pull/96 )
#peek_byte and #scan_byte not updated (not available in my repo --
sorry).
---------
https://github.com/ruby/strscan/commit/0123da7352
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
2024-05-30 12:34:18 +09:00
Alexander Ross
41e6fd066e
[DOC] Fix typo in example code for `String#encode` method
...
The example code in the documentation for the `String#encode` method has
a typo in the `fallback` option. The example code uses `h` as the
fallback option, but it should use `hash` instead to match the variable
name in the example code.
2024-05-14 08:22:36 +00:00
Nobuyoshi Nakada
b911d2222f
[Bug #20482 ] [DOC] Clarify about pattern maching guard clause
...
Guard clauses can only be used in `case` pattern matching statements,
not in `=>`/`in` operators.
2024-05-12 16:23:00 +09:00
KJ Tsanaktsidis
fd2876e6a2
Update ASAN docs to refer to Clang 18's release
...
Clang 18 has the bugfix we need, so we no longer need to tell people to
compile Clang from source.
2024-05-10 10:55:28 +10:00
Diego Henrique
69c1bd90be
[DOC] Fix a typo in globals.rdoc
...
Noticed this small type while reading the docs.
2024-04-26 14:31:36 +00:00
Nobuyoshi Nakada
762491db82
[DOC] Caveat about "allocate then wrap"
2024-04-26 18:17:09 +09:00
Hiroshi SHIBATA
7e8d8f250d
Removed obsoleted section because make docs is removed from default make task
2024-04-24 17:19:04 +09:00
Hiroshi SHIBATA
945a0334c7
Update build and install document related https://blade.ruby-lang.org/ruby-dev/39325
2024-04-17 19:56:20 +09:00
Nobuyoshi Nakada
eaa6e4b228
[DOC] Update PTY documents
...
- Fix markups as RDoc.
- Remove already descriptions of removed methods.
2024-04-07 13:35:20 +09:00
Maxime Chevalier-Boisvert
571bfc7402
YJIT: update code optimization tips in yjit.md ( #10445 )
...
* YJIT: update code optimization tips in yjit.md
* Function => method
2024-04-03 21:28:01 +00:00
Adam Daniels
b664590c4d
[DOC] Fix examples for `u` packing directive
...
The directive is a lowercase `u` instead of an uppercase `U`. Adjusted
input and output to match.
Reported by Leah Neukirchen.
2024-04-03 09:55:24 +09:00
KJ Tsanaktsidis
e02a06fbf2
Document how to run the tests under ASAN now that they pass!
2024-03-31 21:12:31 +11:00
Hiroshi SHIBATA
7630a89a4b
Use www.rfc-editor.org for RFC text.
...
We use the following site for that now:
* https://tools.ietf.org/ or http
* https://datatracker.ietf.org or http
Today, IETF said the official site of RFC is www.rfc-editor.org.
FYI: https://authors.ietf.org/en/references-in-rfcxml
I replaced them to www.rfc-editor.org.
2024-03-28 11:44:45 +09:00
crazeteam
b2b665eba5
[DOC] remove repetitive words in comments
...
Signed-off-by: crazeteam <lilujing@outlook.com>
2024-03-27 07:52:18 +09:00
tomoya ishida
bda5b09937
[ruby/irb] Fix irb_history saved to current directory
...
(https://github.com/ruby/irb/pull/901 )
* Always save irb_history in HOME or XDG_CONFIG_HOME
Also split irbrc search logic from irb_history search logic as a refactor
* Remove IRB.conf[:RC_NAME_GENERATOR] because it's not configurable
This conf is used to specify which irbrc to load. Need to configure before irbrc is loaded, so it's actually not configurable.
This conf is also used for history file search, but it is configurable by conf[:HISTORY_FILE].
* remove rc_file_test because it is tested with rc_files, remove useless test setup
* Make internal irbrc searching method private
https://github.com/ruby/irb/commit/11d03a6ff7
2024-03-16 15:20:03 +00:00
Pierre Merlin
ec4333c970
[DOC] exceptions.rdoc : Add heads up about ensure not returning implicitly
...
There is a weird gotcha I already forgot twice.... and regret not to have found in doc.
See https://dev.to/okuramasafumi/be-sure-ensure-doesn-t-return-value-implicitly-8gp
2024-03-15 22:23:50 +09:00