1291 Commits

Author SHA1 Message Date
nagachika
56ba9041d9 merge revision(s) ae6bd3b49ba252985b92416c24102ede3c0aac9b, 966458199d870b88b42898d4a063b487c1ef6b00, 966458199d870b88b42898d4a063b487c1ef6b00: [Backport #20951]
[DOC] Tweak "Timezone Objects"

	- Make method descriptions plain pragraphs in each method.
	- Make "Argument" and "Returns" note-lists.

	[Bug #20951] [DOC] About UTC offset calculation after `utc_to_local`

	[Bug #20951] [DOC] About UTC offset calculation after `utc_to_local`
2025-03-08 17:03:20 +09:00
Jean byroot Boussier
d1ffd5ecfa
String.new(capacity:) don't substract termlen (#11027)
[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:`.

Co-authored-by: Jean Boussier <jean.boussier@gmail.com>
2024-06-20 10:39:20 -07:00
Hiroshi SHIBATA
077558ee2b
[Bug #20511] Update reline-0.5.7 (#10848)
* Update reline-0.5.7

* Update irb-1.13.1
2024-05-28 15:54:39 -07:00
Maxime Chevalier-Boisvert
ba16b34098
YJIT: reduce default exec mem size to 48MiB (#9692)
* YJIT: reduce default exec mem size to 48MiB based

Based on user feedback from @jhawthorn and others.
Better for small and memory-constrained deployments.

NOTE: This commit should be included in the next Ruby 3.3.x point
release. @xrxr should we tag someone specific?

* YJIT: Update yjit.md about mem size (#9687)

---------

Co-authored-by: Takashi Kokubun <takashikkbn@gmail.com>
2024-02-04 05:36:34 +00:00
Hiroshi SHIBATA
e233730846
Partly reverted c903cddf55af1505a0779e1a131f2fe47b838260
These are intentional words
2023-12-25 11:22:12 +09:00
Hiroshi SHIBATA
c903cddf55
Typofix under doc directory 2023-12-25 11:17:51 +09:00
Takashi Kokubun
3c18277629 RJIT: Clean up unnecessary documentation 2023-12-21 16:47:13 -08:00
Burdette Lamar
4ad1007fd2 [ruby/irb] [DOC] Change indexes.rdoc to indexes.md
(https://github.com/ruby/irb/pull/812)

* Change indexes.rdoc to indexes.md

* Change indexes.rdoc to indexes.md

* Change indexes.rdoc to indexes.md

https://github.com/ruby/irb/commit/b1cd53cbf7
2023-12-20 19:11:02 +09:00
Doug Orleans
1822acdf33 [DOC] remove reference to pre-3.0 splat operator behavior 2023-12-19 22:11:11 +09:00
Nobuyoshi Nakada
a94f3f206e
[DOC] Added notes regarding :nodoc: in C code 2023-12-18 20:17:44 +09:00
Takashi Kokubun
d8978445ae
Improve YJIT documentation for Ruby 3.3 (#9263) 2023-12-17 23:45:09 -05:00
Takashi Kokubun
b266890dab
YJIT: Add --yjit-disable to help and reorder it (#9230) 2023-12-13 13:29:37 -08:00
Burdette Lamar
35990cb38c [ruby/irb] [DOC] RDoc for module IRB
(https://github.com/ruby/irb/pull/738)

[DOC] RDoc for module IRB

https://github.com/ruby/irb/commit/f3a0626298
2023-12-12 10:34:38 +00:00
Nobuyoshi Nakada
bf0c8055ab
[DOC] Fix wording in descriptions of Time-like objects
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
2023-12-05 18:10:56 +09:00
Nobuyoshi Nakada
bf0f56e124
[DOC] Mention Time-like objects 2023-12-05 18:04:02 +09:00
Burdette Lamar
715cf9b690
[DOC] More on What's Here (#9099)
* More on What's Here

* More on What's Here
2023-12-02 11:46:57 -06:00
Nobuyoshi Nakada
092a17e7bd
[DOC] Markup class name Time as code 2023-12-02 21:48:00 +09:00
Nobuyoshi Nakada
ae3e9f114c
[DOC] Include timezones document in timev.rb
So that it can be referred as a part of the document of `Time`.
2023-12-02 21:46:52 +09:00
Jeremy Evans
060f14bf62 Update documentation for [[:word:]] and \p{Word} in regexps
Onigmo uses Decimal_Number and not Number for these.

Fixes [Bug #19417]
2023-11-30 10:40:40 -08:00
Nobuyoshi Nakada
0cdad3b92a Add RUBY_REFERENCES
Instead of `RUBY_REFERENCES_START` and `RUBY_REFERENCES_END`, so that
auto-indent works well.
2023-11-30 21:39:28 +09:00
Nobuyoshi Nakada
30f7b7a053 Prefix REF_EDGE and REFS_LIST_PTR with RUBY_
Also move `struct` so that `typedef`-ed names can be used.
2023-11-30 21:39:28 +09:00
Maxime Chevalier-Boisvert
8d1138c1cf
YJIT: edit yjit.md and bring it up to date (#9068)
Also make various minor edits to improve readability.
2023-11-29 18:09:55 -05:00
Maxime Chevalier-Boisvert
6310522a9a
YJIT: reduce default exec-mem-size to 64MiB (#9054) 2023-11-28 20:04:33 +00:00
Nobuyoshi Nakada
688faa93f0
[DOC] Fix markup in declarative marking API document
- RDoc is not markdown, use `+` and `_` for code and variables
  respectively, instead of backquotes.

- Remove useless backslashes.
2023-11-26 21:49:18 +09:00
Nobuyoshi Nakada
087a919ea4
[DOC] Fix markup
RDoc is not markdown.
2023-11-26 19:18:57 +09:00
Nobuyoshi Nakada
0c0875fe60
[DOC] Mention Time.find_timezone method 2023-11-24 19:38:55 +09:00
Nobuyoshi Nakada
9d7ac1ba1c
[DOC] Add links about timezones 2023-11-24 19:38:55 +09:00
Burdette Lamar
12f4e9655e
Add recommendations on link formatting in documentation 2023-11-23 20:39:24 -08:00
Maxime Chevalier-Boisvert
f9628fb4be
YJIT: make --yjit-max-versions=N option undocumented (#8962)
Not useful for the vast majority of end users to change
this option.
2023-11-20 21:26:18 +00:00
Nobuyoshi Nakada
19a7a7660c
[DOC] Adjust heading levels
So that the first headings would be the top-most headings.
2023-11-14 15:56:58 +09:00
Nobuyoshi Nakada
caa9881fde
[DOC] Fix doc/regexp.rdoc links
- Rename regexp.rdoc to exclude from "Pages".  This file is for to be
  included in the "class Regexp" document, but it also appeared as a
  separate page duplicately.
- Fix links on case-sensitive filesystems.
- Fix to use rdoc-ref instead of converted HTML page names.
2023-11-14 15:56:57 +09:00
tomoya ishida
90b49024c0 [ruby/reline] Fallback to 256color if COLORTERM != truecolor
(https://github.com/ruby/reline/pull/604)

* Fallback to 256color if COLORTERM != truecolor

* Add Reline::Face.force_truecolor to force truecolor without COLORTERM env

https://github.com/ruby/reline/commit/090e1e4df0
2023-11-13 12:42:31 +00:00
Nobuyoshi Nakada
4376a17552
[DOC] Close a tag 2023-11-13 16:04:49 +09:00
Nobuyoshi Nakada
44a6a13cbe
[DOC] Fix Timezone Objects description
From the beginning when Timezone object support was introduced,
Timezone objects are allowed everywhere offset strings are allowed.
2023-11-13 15:59:03 +09:00
Hiroya Fujinami
c49adfab5d
Add "Optimization" section to regexp.rdoc (#8849)
* Add "Optimization" section to regexp.rdoc

* Apply the suggestions by @BurdetteLamar

---------

Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
2023-11-10 01:24:15 +09:00
Nobuyoshi Nakada
b73e087dbc
[DOC] Fix typos 2023-11-09 16:37:03 +09:00
Maxime Chevalier-Boisvert
d9d0938116
YJIT: update yjit.md, add MPLR 2023 paper and bibtex (#8861)
* YJIT: update yjit.md, add MPLR 2023 paper and bibtex

* Update doc/yjit/yjit.md
2023-11-07 17:46:07 +00:00
Takashi Kokubun
ee25ac49f3 [DOC] Use a relative link like other links
following up on https://github.com/ruby/ruby/pull/8832
2023-11-06 09:46:37 -08:00
HASUMI Hitoshi
16403f41ab [ruby/reline] Introduce a new class Reline::Face to configure
character attributes
(https://github.com/ruby/reline/pull/552)

* Reine::Face

* fix test_yamatanooroti

* Define singleton methods to make accessors to attributes of a face

* s/display/foreground/

* s/default/default_style/ && s/normal_line/default/ && s/enhanced_line/enhanced/

* fix typo

* FaceConfig.new now takes keyword arguments

* Update lib/reline/face.rb

Co-authored-by: Stan Lo <stan001212@gmail.com>

* Update test/reline/test_face.rb

Co-authored-by: Stan Lo <stan001212@gmail.com>

* Fix to correspond to frozen_string_literal

* Face::FaceConfig -> Face::Config

* ref https://github.com/ruby/reline/pull/552#pullrequestreview-1677282576

* delete unused ivar

* ref https://github.com/ruby/reline/pull/552#discussion_r1358783723

* insert "\e[0m" into all SGR

* tiny fix

* ESSENTIAL_DEFINE_NAMES

ref https://github.com/ruby/reline/pull/552#discussion_r1367722247

* Change to Hash-accessor style

- Reline::Face[:completion_dialog].enhanced ->
  Reline::Face[:completion_dialog][:enhanced]
- Reline::Face.configs shows all defined values

* Cache array method call in local variable

* Tests for Face configuration variations

* resolve https://github.com/ruby/reline/pull/552#pullrequestreview-1710938154

* amend  to

* check invalid SGR parameter in :style

* The order of define values should be preserved

* Update test/reline/test_face.rb

Co-authored-by: Stan Lo <stan001212@gmail.com>

* Update test/reline/test_face.rb

Co-authored-by: Stan Lo <stan001212@gmail.com>

* Add methods: load_initial_config and reset_to_initial_config. And teardown in tests

* omission in amending "style: :default" to "style: :reset"

* refs https://github.com/ruby/reline/issues/598

* Fix link

* amend method name

* Update lib/reline/face.rb

Co-authored-by: ima1zumi <52617472+ima1zumi@users.noreply.github.com>

---------

https://github.com/ruby/reline/commit/fdc1d3b1e5

Co-authored-by: Stan Lo <stan001212@gmail.com>
Co-authored-by: ima1zumi <52617472+ima1zumi@users.noreply.github.com>
2023-11-06 14:40:42 +00:00
JorandeBoer
a763d085e4 Updated building_ruby.md to include reference for building on Windows
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
2023-11-06 11:52:31 +09:00
Lars Kanis
7523ede7ba Windows: Fix description of runtimes
`mswin` platform links to `vcruntimeXXX.dll` but `mingw-ucrt` doesn't.
2023-11-02 15:16:41 +09:00
Kevin Newton
d9cb75b741 List prism as a default gem 2023-11-01 22:16:33 -04:00
Lars Kanis
7e6204dd10 Windows: Add libffi as a build dependency
Otherwise the fiddle extension isn't build.
2023-10-28 10:44:16 +09:00
Kouhei Yanagita
b84e6fe93e
[DOC] Mention the omission of a superclass when reopening a class 2023-10-22 20:12:16 +09:00
Nobuyoshi Nakada
0061eaddc9
[DOC] configure -C tips 2023-10-20 16:33:23 +09:00
Matheus Richard
72f97ee06e
[DOC] Improve docs for how to generate documentation
It might not be obvious how to get the build directory and the Makefile
set up.
2023-10-20 08:45:07 +09:00
Maxime Chevalier-Boisvert
3e65115cef
YJIT: remove unused --yjit-greedy-versioning command-line option (#8713) 2023-10-19 19:29:31 +00:00
Takashi Kokubun
f51b92fe23
YJIT: Add --yjit-perf (#8697)
Co-authored-by: Alan Wu <alansi.xingwu@shopify.com>
2023-10-18 21:07:03 +00:00
Jun Aruga
13dafb210e [DOC] testing_ruby.md: Add spec/ for the explanation of the make check. 2023-10-14 22:43:41 -07:00
Jun Aruga
df1887414a [DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts.
Remove the command prompt '$ ` aligning with other parts in the document.
2023-10-14 22:43:41 -07:00