github
/
ruby
зеркало из https://github.com/github/ruby.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
74 548 коммитов 220 Ветки 1 267 Теги 407 MiB
Граф коммитов

1103 Коммитов

Автор SHA1 Сообщение Дата
Burdette Lamar c19a631c99
[DOC] Enhancements for encoding.rdoc (#5578) 
Adds sections:

    String Encoding
    Symbol and Regexp Encodings
    Filesystem Encoding
    Locale Encoding
    IO Encodings
        External Encoding
        Internal Encoding
    Script Encoding
    Transcoding
        Transcoding a String
 2022-02-24 14:10:49 -06:00
Adrien S fc7e42a473
Fix yjit readme link pointing to old shopify readme (#5596) 2022-02-24 14:12:17 -05:00
Burdette Lamar 883fe55c4b
New doc about encoding (#5572) 
This is the beginning of an extended explication of Ruby encoding.

One of its more important jobs is to provide link targets for encoding documentation in other classes (String, File, IO, etc.). In particular, they can link to the "Encoding Options" section.

I'll have much to add to this document going forward, along with suitable adjustments in the class documentation.
 2022-02-18 13:33:18 -06:00
Burdette Lamar e9a2b30744
Enhanced RDoc concerning command injection (#5537) 
Clarifies security vulnerabilities for commands.

Treats:

    Kernel.system
    Kernel.` (backtick)
    IO.popen
    IO.read
    IO.write
    IO.binread
    IO.binwrite
    IO.readlines
    IO.foreach
 2022-02-18 06:46:04 -06:00
Nobuyoshi Nakada adca6f24b1
[DOC] Prefer the original file names over generated names 
Should also the label in an explicit `rdoc-ref:` link be converted
in the future?
 2022-02-09 15:31:10 +09:00
Max Leopold 203b1fc7e2 Add documentation for regexp emoji named character property 2022-02-04 08:26:49 +09:00
Kazuhiro NISHIYAMA aff4b2194f
Fix a typo [ci skip] 2022-02-02 09:08:12 +09:00
Steven Nunez b01657c470
[DOC] Fix case for new sentence. 2022-01-31 07:59:10 +09:00
manga_osyo 8d378fd28b Add Enumerable::Lazy#with_index to NEWS-2.7.0 
The behavior of `Enumerable::Lazy#with_index` has changed in Ruby 2.7.
This change was not listed in the Ruby 2.7 news, so I added it.
 2022-01-15 09:09:12 +09:00
Nobuyoshi Nakada 92630e2346
[ruby/optparse] Fix links to the page directory files [Bug #18468] 
https://github.com/ruby/optparse/commit/dab72c543d
 2022-01-12 21:16:02 +09:00
Nobuyoshi Nakada 39bebd762d
[ruby/optparse] Add .document files 
https://github.com/ruby/optparse/commit/ed283559d4
 2022-01-12 21:16:01 +09:00
Noah Gibbs 14967347b9
YJIT stats documentation additions and updates (#5427) 
* YJIT documentation additions and updates

* Update yjit.md

Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com>
 2022-01-11 14:17:59 -05:00
Alan Wu 04d9b6d2f9 [DOC] Link to Ruby Spec and rephrase project goal 
The word "specification" can be confusing as it might make readers
assume that the Ruby Spec Suite is a specification similar to an ISO
specification. Avoid the word and link to the project so curious parties
could read more about the project.
 2022-01-10 18:02:00 +01:00
Benoit Daloze ca97001a94 Make the Ractor-safe section more fluent 2022-01-10 13:08:59 +01:00
Trey Evans b4d0d07e2c Clarify ractor documentation meaning and formatting. 2022-01-10 13:04:31 +01:00
Nobuyoshi Nakada 65a8d52212
Revert "[DOC] Mention RBOOL in extension.rdoc [Feature #13125]" 
This reverts commit 9ad34da47f, as
`RBOOL` is not defined publicly yet.
 2022-01-09 19:17:48 +09:00
Nobuyoshi Nakada b43ad6b802
[DOC] Fold too long lines 2022-01-09 13:21:52 +09:00
Nobuyoshi Nakada 83983bacbc
[DOC] Mention `make check` 2022-01-09 12:40:25 +09:00
Nobuyoshi Nakada cc01ae591b
[DOC] test-spec would be preferable now 2022-01-09 12:34:11 +09:00
Samuel Williams 8648457541
Don't combine test-all and rubyspec. 2022-01-09 12:06:20 +13:00
Jeremy Evans f53dfab95c Add support for anonymous rest and keyword rest argument forwarding 
This allows for the following syntax:

```ruby
def foo(*)
  bar(*)
end
def baz(**)
  quux(**)
end
```

This is a natural addition after the introduction of anonymous
block forwarding.  Anonymous rest and keyword rest arguments were
already supported in method parameters, this just allows them to
be used as arguments to other methods.  The same advantages of
anonymous block forwarding apply to rest and keyword rest argument
forwarding.

This has some minor changes to #parameters output.  Now, instead
of `[:rest], [:keyrest]`, you get `[:rest, :*], [:keyrest, :**]`.
These were already used for `...` forwarding, so I think it makes
it more consistent to include them in other cases.  If we want to
use `[:rest], [:keyrest]` in both cases, that is also possible.

I don't think the previous behavior of `[:rest], [:keyrest]` in
the non-... case and `[:rest, :*], [:keyrest, :**]` in the ...
case makes sense, but if we did want that behavior, we'll have to
make more substantial changes, such as using a different ID in the
... forwarding case.

Implements [Feature #18351]
 2021-12-30 14:37:42 -08:00
Kazuhiro NISHIYAMA f445eccfb4
Expand URL to its canonical form [ci skip] 2021-12-28 10:23:46 +09:00
Kazuhiro NISHIYAMA 53b3c044fc
Copy NEWS.md to doc/NEWS-3.1.0.md and update for 3.2.0 2021-12-25 23:11:43 +09:00
Victor Shepelev a0f10a973f
[DOC] Add documentation for hash value omission syntax 2021-12-20 01:09:52 +09:00
Samuel Williams 78c175280b Fix code formatting. 2021-12-18 23:10:42 +13:00
Samuel Williams 1560cc1688 Introduce setup instructions for better parallelism. 2021-12-18 23:10:42 +13:00
Samuel Williams 75b5a4808f Initial hacking guide. 2021-12-18 19:15:11 +13:00
Burdette Lamar f7e266e6d2
Enhanced RDoc for case mapping (#5245) 
Adds file doc/case_mapping.rdoc, which describes case mapping and provides a link target that methods doc can link to.

Revises:

    String#capitalize
    String#capitalize!
    String#casecmp
    String#casecmp?
    String#downcase
    String#downcase!
    String#swapcase
    String#swapcase!
    String#upcase
    String#upcase!
    Symbol#capitalize
    Symbol#casecmp
    Symbol#casecmp?
    Symbol#downcase
    Symbol#swapcase
    Symbol#upcase
 2021-12-17 06:05:31 -06:00
Lars Kanis fff058a8d6 Add description of ruby header files to extension.rdoc 2021-12-16 20:10:55 +09:00
Nobuyoshi Nakada 9ad34da47f
[DOC] Mention RBOOL in extension.rdoc [Feature #13125] 2021-12-13 13:21:53 +09:00
Alan Wu 74159f7f3e
[DOC] Stop mentioning Qfalse==0 for C extensions 
See [Feature #18397] for detail. Follow up for
b859397e1b.

[ci skip]

Co-authored-by: Koichi Sasada <ko1@atdot.net>
 2021-12-09 13:38:20 -05:00
Jemma Issroff b859397e1b
[DOC] Stop recommending Qfalse==0 assumption to C extensions 
Encourage use of RTEST(), direct Qfalse comparison, and remove references to
Qfalse == 0 in extension documentation.

See [Bug #18397] for detail.
[ci skip]
 2021-12-09 11:23:51 -05:00
aycabta fa806cf233 Fix typo of namespace 2021-12-09 18:15:52 +09:00
Akihiro Sada c5f68a9a24
Fix typo in NEWS-2.5.0 [ci skip] 2021-12-09 12:28:42 +09:00
Burdette Lamar 0209beaca6
Enhanced RDoc for literals.rdoc (#5213) 
Makes link targets among percent literals.
    Adds links to those targets.
    Adds examples to percent literals.
    Links from opening summary list to corresponding sections.
 2021-12-06 16:26:28 -06:00
Burdette Lamar 28fb6d6b9e
Adding links to literals and Kernel (#5192) 
* Adding links to literals and Kernel
 2021-12-03 07:12:28 -06:00
Burdette Lamar eac7c63538
Enhanced RDoc for numeric.c (#5184) 
Adds remarks about literals and Kernel methods to Float and Integer.
 2021-11-27 13:07:37 -06:00
Adam Hess 8bde66167f
update YJIT docs to reference RubyVM::YJIT instead of just YJIT 
[ci skip]
 2021-11-24 20:23:22 -05:00
furunkel 1dcfcb6bc5 Fix typo 2021-11-24 23:06:28 +09:00
Jeremy Evans 4adb012926 Anonymous block forwarding allows a method to forward a passed 
block to another method without having to provide a name for the
block parameter.

Implements [Feature #11256]

Co-authored-by: Yusuke Endoh mame@ruby-lang.org
Co-authored-by: Nobuyoshi Nakada nobu@ruby-lang.org
 2021-11-18 14:17:57 -08:00
Maxime Chevalier-Boisvert cdebf57ec6
Add --yjit-no-type-prop so we can test YJIT without type propagation (#5135) 
* Add --yjit-no-type-prop so we can test YJIT without type propagation

* Fix typo in command line option

* Leave just two test workflows enable for YJIT
 2021-11-18 10:44:31 -05:00
Samuel Williams 81d0ce7e97 Mark IO::Buffer as experimental. 2021-11-10 19:21:05 +13:00
Samuel Williams 4b89034218 IO::Buffer for scheduler interface. 2021-11-10 19:21:05 +13:00
Kazuhiro NISHIYAMA ac642df228
Revert "Fix typo in ChangeLog-2.0.0 [ci skip]" 
This reverts commit e5792e7d55.

Because this is correct ChangeLog of
89fef02f13
and reverted commit makes inconsistency with
171c708b0c
 2021-11-07 13:13:32 +09:00
180909 e5792e7d55
Fix typo in ChangeLog-2.0.0 [ci skip] 2021-11-06 10:46:09 +09:00
Kazuhiro NISHIYAMA a53aab1273
Fix typos [ci skip] 2021-11-04 12:58:09 +09:00
180909 ee9f7fc2f7 fix typo in ChangeLog-1.9.3 2021-11-04 12:08:12 +09:00
Nobuyoshi Nakada e0915ba679
Fix typos in ChangeLog files [ci skip] 2021-11-02 19:17:37 +09:00
Peter Leitzen 09bdb43567 Clarify docs about magic comments placement 
Magic comments like `frozen_string_literal` may appear everywhere
within the first comment section while `encoding` have to be the first
line, or second line after shebang.
 2021-10-30 09:59:59 +09:00
Steven Nunez f180fa6ca3 Fix Typo 2021-10-26 13:10:49 -04:00
Koichi Sasada df9fac5ccd update doc/ractor.md about ivars 2021-10-23 01:32:55 +09:00
Nobuyoshi Nakada 4d4bdcf368
Move the test file 2021-10-21 13:07:48 +09:00
Maxime Chevalier-Boisvert 2e2430564a Update yjit.md 2021-10-20 18:19:43 -04:00
Alan Wu adcee68aa0 Doc: remove outdated note about hooking into the interpreter 
DAE remember MicroJIT?
 2021-10-20 18:19:43 -04:00
Alan Wu 8a9a2d0049 Move test_yjit_asm.sh into misc 
Since conventionally scripts don't live at the top level of the repo.
 2021-10-20 18:19:43 -04:00
Maxime Chevalier-Boisvert d11ea2520e Update yjit.md 2021-10-20 18:19:43 -04:00
Noah Gibbs 3dd4abfcd0 Move YJIT's README into doc/yjit/yjit.md 2021-10-20 18:19:42 -04:00
Noah Gibbs 6392702375 Incorporate feedback from the PR into yjit_hacking.md 2021-10-20 18:19:42 -04:00
Noah Gibbs d4a75dd976 Add a YJIT hacking doc with some internals; change the README text a bit to reflect its current condition 2021-10-20 18:19:42 -04:00
Maxime Chevalier-Boisvert 10217d147c Rename YJIT readme to README.md 2021-10-20 18:19:34 -04:00
Maxime Chevalier-Boisvert 04243533fc Update yjit.md 2021-10-20 18:19:33 -04:00
Maxime Chevalier-Boisvert 98e93d6a8f Update yjit.md 2021-10-20 18:19:32 -04:00
Marc Feeley aba4047955 Update yjit.md 
Fix a typo in the bibtex.
 2021-10-20 18:19:32 -04:00
Maxime Chevalier-Boisvert 4ccfbfe6fa Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert 46874b8fb9 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert c56243dab4 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert 4a99990b36 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert e4e453c7d0 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert 7b38bf189e Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert f2b170b01d Update and rename ujit.md to yjit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 5c497dfd7f Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 831ac473fa Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 6f437d5b30 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 0888d9c9d5 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 8e5222c887 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 028e017e95 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 47900e10e3 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 6100b52ecf Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 9d62ab303c Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 7fbbd0c67c Update ujit.md 2021-10-20 18:19:29 -04:00
Maxime Chevalier-Boisvert 2babfeb858 Update ujit.md 2021-10-20 18:19:29 -04:00
Maxime Chevalier-Boisvert 701a802a42 Create ujit.md 2021-10-20 18:19:29 -04:00
mitsu-ksgr 2962c421e1
[DOC] fix small mistake in doc/marshal.rdoc [ci skip] 2021-10-03 11:09:08 +09:00
U.Nakamura 6bca410ae8 Move platform maintainers list 2021-09-28 15:50:38 +09:00
aycabta 00cfafc0f5 [ruby/irb] Add doc about "echo on assignment" 
https://github.com/ruby/irb/commit/5af637b3c1
 2021-09-27 03:23:48 +09:00
Nobuyoshi Nakada a27c274f04
[DOC] Fix broken links [ci skip] 
* As the "doc/" prefix is specified by the `--page-dir` option,
  remove from the rdoc references.
* Refer to the original .rdoc instead of the converted .html.
 2021-09-15 14:16:14 +09:00
Burdette Lamar 1af5a0c574
Bsearch doc for Array and Range (#4838) 
This PR creates doc/bsearch.rdoc to provide common documentation for bsearch in Array and Range.
 2021-09-14 16:08:21 -05:00
Kazuhiro NISHIYAMA 6f35a4e526
Use `./autogen.sh` instead of `autoconf` in doc 2021-09-11 12:29:59 +09:00
Koichi Sasada 3d4207f9bb
Need `#` 
`shareable_constant_value` is magic comment.
 2021-09-10 13:51:50 +09:00
Kenta Murata f8bb2d9b27
memory_view.c: Rename private to private_data for C++ (#4812) 
* memory_view.c: Rename private to private_data for C++

* doc/memory_view.md: Update document

* Fix doc/memory_view.md

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
 2021-09-06 16:01:52 +09:00
aycabta ece4ed0da7 Add --autocomplete / --noautocomplete options 2021-08-30 02:45:13 +09:00
Nobuyoshi Nakada f51a6ace06
[DOC] prefer RUBY_DEFAULT_FREE to a magic number [ci skip] 2021-08-21 16:50:51 +09:00
Nobuyoshi Nakada 8f755ad6c8
[DOC] mention rb_define_alloc_func [ci skip] 2021-08-21 16:48:13 +09:00
Nobuyoshi Nakada 5e7cc0eebe
[DOC] update extension.ja.rdoc [ci skip] 
`rb_cData` has been deprecated for years.
 2021-08-21 11:21:37 +09:00
Kazuki Tsujimoto ecb6d6a4ef
Allow omission of parentheses in one line pattern matching [Feature #16182] 2021-08-19 17:07:58 +09:00
Hiroshi SHIBATA 23ef326656
Manually picking https://github.com/ruby/optparse/pull/14 2021-07-28 20:13:39 +09:00
Olle Jonsson 3026ee56b1
[ruby/optparse] Remove an errant { character (https://github.com/ruby/optparse/pull/26) 
https://github.com/ruby/optparse/commit/47417f1b4c
 2021-07-28 20:13:39 +09:00
Burdette Lamar c4556a2022
[ruby/optparse] Fix link in included file 
https://github.com/ruby/optparse/commit/bf03038d95
 2021-07-28 20:13:39 +09:00
Burdette Lamar 1333620afd
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/24) 
- Adds section "Parsing" to tutorial.rdoc.
- Removes section "Terminators" from option_params.rdoc. (Terminator '--' is not an option parameter.)

https://github.com/ruby/optparse/commit/40d51ccbad
 2021-07-28 20:13:39 +09:00
Burdette Lamar 27679b349e
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/23) 
- Removed a largish block of repeated text.
- Added sections "Top List and Base List" and "Methods for Defining Options" (on, define, etc.).
- Linked from class OptionParser doc to the tutorial.

https://github.com/ruby/optparse/commit/7f3195b9db
 2021-07-28 20:13:39 +09:00
Nobuyoshi Nakada a10db32003
[ruby/optparse] Removed a duplicate section 
https://github.com/ruby/optparse/commit/7ef3d89e78
 2021-07-28 20:13:39 +09:00
Burdette Lamar 98ccb49ac3
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/22) 
Adds argument abbreviation in option_params.rdoc.
    Adds entire Argument Values section to tutorial.rdoc.

https://github.com/ruby/optparse/commit/9c5b3f244b
 2021-07-28 20:13:39 +09:00
Burdette Lamar 43af561e08
[ruby/optparse] Rdoc for help (https://github.com/ruby/optparse/pull/21) 
https://github.com/ruby/optparse/commit/d07cb96a96
 2021-07-28 20:13:39 +09:00
Burdette Lamar a15f0b9fe2
[ruby/optparse] Tutorial: explain custom argument converters (https://github.com/ruby/optparse/pull/19) 
https://github.com/ruby/optparse/commit/385dd4322d
 2021-07-28 20:13:39 +09:00
Nobuyoshi Nakada 311eb328c8
[ruby/optparse] Fixed mismatched <tt> tag 
https://github.com/ruby/optparse/commit/7e65ef3cfa
 2021-07-28 20:13:38 +09:00
Burdette Lamar a4631a4273
[ruby/optparse] Enhanced doc for option parameters (https://github.com/ruby/optparse/pull/11) 
https://github.com/ruby/optparse/commit/5618eeb49e
 2021-07-28 20:13:38 +09:00
Burdette Lamar 05e9efa323
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/9) 
* More on tutorial

* More on tutorial

* More on tutorial

* More on tutorial: clearer example output

https://github.com/ruby/optparse/commit/84dfd92d2a
 2021-07-28 20:13:38 +09:00
BurdetteLamar 8844eba488
[ruby/optparse] Beginnings of tutorial 
https://github.com/ruby/optparse/commit/f209276f79
 2021-07-28 20:13:38 +09:00
Jeremy Evans 4fc9ddd7b6 Update Capturing and Anchors sections of regexp documention 
Document that only first 9 numbered capture groups can use the \n
backreference syntax.  Document \0 backreference.  Document \K anchor.

Fixes [Bug #14500]
 2021-07-27 12:30:43 -07:00
Ulysses Zhan e4b68ab700
[DOC] Fixed the description of regexp alternations [ci skip] 2021-07-22 14:10:57 +09:00
Burdette Lamar a541fe1a75
Doc guide for class/module (#4600) 
Co-authored-by: Marivaldo Cavalheiro <marivaldo@gmail.com>
 2021-07-18 18:43:34 -04:00
Kazuki Tsujimoto eed5e8f796
One-line pattern matching is no longer experimental 
https://github.com/ruby/dev-meeting-log/blob/master/DevelopersMeeting20210715Japan.md#feature-17724-make-the-pin-operator-support-instanceclassglobal-variables-jeremyevans0
 2021-07-17 11:13:52 +09:00
Jeremy Evans fa87f72e1e Add pattern matching pin support for instance/class/global variables 
Pin matching for local variables and constants is already supported,
and it is fairly simple to add support for these variable types.

Note that pin matching for method calls is still not supported
without wrapping in parentheses (pin expressions).  I think that's
for the best as method calls are far more complex (arguments/blocks).

Implements [Feature #17724]
 2021-07-15 09:56:02 -07:00
Kazuhiro NISHIYAMA e105d93b4f
Fix default prompt mode in doc/irb/irb.rd.ja 2021-07-02 13:23:20 +09:00
Samuel Williams 2792acc8f2
Add scheduler hook `Addrinfo.getaddrinfo`. (#4375) 
Co-authored-by: Bruno Sutic <code@brunosutic.com>
 2021-06-14 16:21:08 +12:00
Hiroshi SHIBATA be2e2b4805 Promote net-smtp to the bundled gems 2021-05-27 14:42:11 +09:00
Hiroshi SHIBATA aa9726f7b9 Promote net-pop to the bundled gems 2021-05-27 14:42:11 +09:00
Hiroshi SHIBATA d5bc6b2337 Promote net-imap to the bundled gems 2021-05-27 14:42:11 +09:00
Hiroshi SHIBATA e49c998d1e Promote net-ftp to the bundled gems 2021-05-27 14:42:11 +09:00
Hiroshi SHIBATA 454a36794f Promote matrix to the bundled gems 2021-05-27 14:42:11 +09:00
Hiroshi SHIBATA c9178c1127 Promote prime to the bundled gems 2021-05-27 14:42:11 +09:00
Hiroshi SHIBATA edcc29dcff Removed gdbm from ruby repo 2021-05-25 20:04:54 +09:00
Hiroshi SHIBATA 55cd3e4ebf Removed dbm from ruby repo 2021-05-25 15:18:31 +09:00
Hiroshi SHIBATA ab3266ea5c Removed tracer from ruby repo 2021-05-25 13:13:52 +09:00
Hiroshi SHIBATA 4aaa98e626
xibbar is retired from cgi.rb maintainer 2021-05-24 18:37:18 +09:00
Jeremy Evans 2e919e4a64 Remove extra word in heredoc documentation 
From Thibault Jouan

Fixes [Misc #17872]
 2021-05-20 12:24:41 -07:00
Jeremy Evans ee1725cecb Update keyword argument description in method syntax guide 
Remove discussion of Ruby 2.7 specific handling of keyword
argument separation.  Add a small example of keyword to
positional hash conversion for methods not accepting
keyword arguments.
 2021-05-11 15:45:52 -07:00
Burdette Lamar 86b4c2fc3f
What's Here for class Dir (#4472) 
What's Here for class Dir
 2021-05-07 15:14:08 -05:00
Burdette Lamar 6ee55455a8 Update Time documentation 2021-04-29 19:58:15 -07:00
Ryuta Kamizono 33f2ff3bab Fix some typos by spell checker 2021-04-26 10:07:41 +09:00
wonda-tea-coffee e71bc56efe [Doc] Fix a typo s/evel/eval/ 2021-04-25 19:45:42 +12:00
wonda-tea-coffee fc84e6679d [Doc] Fix a typo s/invokations/invocations/ 2021-04-25 19:45:01 +12:00
Nobuyoshi Nakada f89486965b [ruby/optparse] Moved rdoc files to doc/optparse 
https://github.com/ruby/optparse/commit/cccb28e0de
 2021-04-11 09:03:36 +09:00
Nobuyoshi Nakada cb01437c24 [ruby/optparse] Fix relative paths 
https://github.com/ruby/optparse/commit/8be031b539
 2021-04-11 08:52:58 +09:00
Burdette Lamar 1bad4bdf52 [ruby/optparse] More on tutorial (#16) 
-   Added example in "Argument Converters"; it doesn't seem right for a tutorial to have no example in one of its topics (and instead just linking elsewhere).
-   Added section "Command-Line Abbreviations."
 -  Added section "Keyword Argument into," showing how to:
     -  Collect options.
     -  Check for missing options.
     -  Provide option defaults.

https://github.com/ruby/optparse/commit/39d39676c4
 2021-04-11 08:52:54 +09:00
Burdette Lamar ff0dac1849 [ruby/optparse] Rdoc (#15) 
* Resolve shared mixed_names.rb

* Add long option with negation

* Show --help for all examples

* Table of contents for tutorial

* Move argument converters to separate rdoc

* Add references to argument_converters.rdoc

* Tune up argument converters

* Change explicit links to auto-links

https://github.com/ruby/optparse/commit/c91ed8d33d
 2021-04-11 08:52:52 +09:00
Burdette Lamar c795f30ef0 [ruby/optparse] Reorganize Ruby example files for sharing (#14) 
https://github.com/ruby/optparse/commit/9a2352c1c9
 2021-04-11 08:52:50 +09:00
BurdetteLamar a5ecce9187
[ruby/optparse] Make use of option_params.rdoc 
https://github.com/ruby/optparse/commit/d55d9284c3
 2021-04-08 12:11:42 +09:00
Burdette Lamar 5891159f96
[ruby/optparse] Enhanced doc for option parameters (#11) 
https://github.com/ruby/optparse/commit/5618eeb49e
 2021-04-08 12:11:42 +09:00
Burdette Lamar fe72cff487
[ruby/optparse] More on tutorial (#9) 
* More on tutorial: clearer example output

https://github.com/ruby/optparse/commit/84dfd92d2a
 2021-04-08 12:11:32 +09:00
BurdetteLamar 0d1d779c23 [ruby/optparse] Beginnings of tutorial 
https://github.com/ruby/optparse/commit/f209276f79
 2021-04-08 12:09:29 +09:00
Samuel Williams 511acba4ae Update method name and add documentation. 2021-03-30 18:38:42 +13:00
Kenichi Kamiya 31ae931e16
[Doc] Update regex engine to Onigumo in doc/extension.* [ci skip] 
regex.c has been removed in 8e65234086
 2021-03-27 17:22:57 +09:00
Kazuki Tsujimoto 21863470d9
Pattern matching pin operator against expression [Feature #17411] 
This commit is based on the patch by @nobu.
 2021-03-21 15:14:31 +09:00
Kenichi Kamiya c7e6914b39 [Doc] Fix multiple `Magic Comments` example 
[ci skip]
 2021-03-13 15:44:34 +09:00
Lars Kanis 09c74a1702 [DOC] Fix copy+paste mistake [ci skip] 
It was introduced in commit 089b7a8460 .
 2021-02-23 10:48:31 +09:00
Lars Kanis 089b7a8460
Improve extension docs, remove deprecated rb_cData [ci skip] 
rb_cData is deprecated and the characteristic alloc_func was already
removed in ruby-3.0. So this updates the recommendation accordingly.

It also adds fdbm_alloc() in order to show the allocation process
and to gives TypedData_Make_Struct() more context.

Moreover it describes fdbm_aref(), so that the relation to
rb_define_method() is shown.

And fdbm_aref() makes use of GetDBM() now, to show how this macro
might be used.
 2021-02-22 12:18:16 +09:00
Nobuyoshi Nakada f3f78f9654
[DOC] Improved regexp.rdoc [ci skip] 
* Sub-sectioned "Repetition" section
* Added examples of "Possessive match"
 2021-02-11 22:20:41 +09:00
Use amazing-print instead 189bf0106f Fix broken link 
The document should point to doc/syntax/comments.rdoc (with an "s") as there currently no `doc/syntax/comment.rdoc`
 2021-02-09 13:16:32 -08:00
Use amazing-print instead e7a831de8e Improve the wording surrounding `Proc#isolate` 
This change moves the statement that `Proc#isolate` isn't yet exposed for Ruby users to the first time the method is mentioned. This is so that readers don't waste time trying to look it up in Ruby docs.

There was also unnecessary duplication:
```
Paragraph 1: "Given block will be isolated from outer scope by Proc#isolate."
Paragraph 2: "Given block will be isolated by Proc#isolate method"
```
So I combined the two sentences and slightly improved the wording for clarity.
 2021-02-09 08:22:37 -05:00
Masataka Pocke Kuwabara 23a833ee67
Add File.absolute_path? to NEWS-2.7.0 [ci skip] 
`File.absolute_path?` has been added since Ruby 2.7.0, but it isn't
mentioned in the NEWS. So this patch adds a NEWS entry.

ref: https://bugs.ruby-lang.org/issues/15868

Co-authored-by: nagachika <nagachika@ruby-lang.org>
 2021-02-01 14:01:47 +09:00
Hiroshi SHIBATA 19902e2e0a
Update the maintainer of net-smtp 2021-01-17 08:14:02 +09:00
Burdette Lamar e7f1afbccd
Additions to method_documentation.rdoc (#4065) 
* Additions to method_documentation.rdoc
 2021-01-15 14:25:56 -06:00
Marc-Andre Lafortune 65787f18b9 Typo fixes [doc] 2021-01-12 23:30:47 -05:00
Adam Pogwizd 75212f2fc6
Update wording in ractor.md (#4056) [doc] 2021-01-12 23:28:34 -05:00
Marcus Stollsteimer 3108ad7bf3 [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
Marc-Andre Lafortune a495cb2fd5 NEWS-3.0.0: backquote a few code related words. [doc] 2021-01-02 21:55:03 -05:00
Marc-Andre Lafortune fdf3539967 NEWS: We have links now, and there is no changelog anymore [doc] 2021-01-02 21:54:00 -05:00
Marcus Stollsteimer 228ad7d84b doc/ractor.md: Fix indentation 
Reintroduce removed empty line to fix indentation on rendered page
(the first line is _not_ indented despite the leading spaces,
and ends up "outdented" compared to the rest of the block).

Also add a missing "-".
 2020-12-27 22:39:42 +01:00
Sampat Badhe 677ccb927c [ruby/csv] fix typo conveters => converters for CSV parsing docs (#196) 
https://github.com/ruby/csv/commit/77ccf486fe
 2020-12-27 15:27:03 +09:00
Marcus Stollsteimer ab6adf2772 doc/ractor.md: Fix indentation in code blocks 
Remove unnecessary indentation of code in code blocks
(it is also not rendered properly in the generated HTML).

Also remove an empty line.
 2020-12-26 22:51:48 +01:00
Marcus Stollsteimer 3fc53de5c9 methods.rdoc: Improve method definition documentation 
* typos, grammar, formatting
* use `concrete_method` again in `regular_method` example,
  to better distinguish from `forwarding_method` example
* clarify that leading arguments before `...` require Ruby 3.0
 2020-12-26 10:40:52 +01:00
Marcus Stollsteimer ce65a7687f methods.rdoc: Clarify "currently" means "in 2.7" here 2020-12-26 10:40:47 +01:00
zverok 255ee4de8c Update method definition documentation 
* Add endless methods
* Add argument forwarding ...
 2020-12-25 22:10:09 +09:00
Nobuyoshi Nakada aaf0474e76
Adjusted the heading level of "Block Arguments" [ci skip] 2020-12-25 22:09:22 +09:00
Kazuhiro NISHIYAMA 7e3d710a22
Copy NEWS.md to doc/NEWS-3.0.0.md and update for 3.1.0 2020-12-25 17:31:48 +09:00
Kenta Murata 9b091084a1
[memory_view] Add documentation [ci skip] 2020-12-25 01:44:54 +09:00
Marcus Stollsteimer 9f9a389d95 doc/syntax/pattern_matching.rdoc: fix typos, grammar, style 2020-12-24 11:35:03 +01:00
Marcus Stollsteimer a4419a55f0 doc/extension.ja.rdoc: remove trailing whitespace 2020-12-24 11:31:06 +01:00
Marcus Stollsteimer c601a7ecfd doc/keywords.rdoc: fix typo 2020-12-24 11:30:30 +01:00
Yusuke Endoh 1a74fb011d doc/maintainers.rdoc: typo 2020-12-24 18:03:39 +09:00
Koichi Sasada 8664c3ddef update doc/ractor.md 2020-12-24 17:51:47 +09:00
Yusuke Endoh 85f0179479 doc/keywords.rdoc: mention pattern matching in the `in` keyword section 2020-12-24 17:15:24 +09:00
Yusuke Endoh 1729fd8c0a doc/contributing.rdoc: remove outdated content 2020-12-24 17:00:30 +09:00
Marc-Andre Lafortune 8aa299de24 Tweak magic comments [doc] 2020-12-24 01:36:08 -05:00
Koichi Sasada e43b5aa52d remove redundant example. 
pointed by @marcandre.
 2020-12-24 14:31:01 +09:00
Koichi Sasada 6f29716f9f shareable_constant_value: experimental_copy 
"experimental_everything" makes the assigned value, it means
the assignment change the state of assigned value.
"experimental_copy" tries to make a deep copy and make copyied object
sharable.
 2020-12-24 14:28:47 +09:00
Koichi Sasada 9aca51e8a5 add about Ractor into extension.rdoc [ci skip] 2020-12-24 12:10:17 +09:00
Marcus Stollsteimer ae26d5bd41 doc/fiber.md: fix typos 2020-12-23 21:56:04 +01:00
Marcus Stollsteimer 458d5175b9 Small improvements in magic comments docs 
* remove a duplicate statement
* fix rdoc markup
* fix typos
 2020-12-23 19:47:26 +01:00
Marc-Andre Lafortune 8feb40f49a Document shareable_constant_value and other magic constants [doc] 2020-12-23 11:50:33 -05:00
Kazuki Tsujimoto b222a1a494
Fix a message in example code 
Thanks to @zverok for the report.
 2020-12-23 02:37:27 +09:00
Hiroshi SHIBATA f08cbdbf7d
Move the library to extensions for some of default gems 2020-12-22 20:55:41 +09:00
Samuel Williams 93a56a5e98 Update fiber scheduler documentation. 2020-12-22 23:51:02 +13:00
Kazuki Tsujimoto 5c0abe2d94
Update documentation for pattern matching 2020-12-22 02:08:57 +09:00
Ivan Denysov 435b619a3d fix phrasing in comment 2020-12-20 12:38:11 -05:00
Kazuki Tsujimoto 85ec6cc387
Fix markups and indentation 2020-12-20 13:35:20 +09:00
Kazuki Tsujimoto d37be18af5
Fix typos 2020-12-20 13:25:43 +09:00
Kazuki Tsujimoto 4902f96ee5
Update documentation for pattern matching 2020-12-20 13:22:53 +09:00
Nobuyoshi Nakada 553d6fa0a0
[DOC] Marked dtrace arguments as description list [ci skip] 2020-12-19 15:34:37 +09:00
Nobuyoshi Nakada a5832c9a37
[DOC] Fixed markups in dtrace_probes.rdoc [ci skip] 
* `+` can enclose just a word.
* TIDYLINK with braces gets confused when other braces even inside
  code precede.
 2020-12-19 15:34:37 +09:00
Kazuhiro NISHIYAMA 85a7f723c3
Fix a typo [ci skip] 2020-12-14 10:26:04 +09:00
Kazuki Tsujimoto 88f3ce12d3
Reintroduce `expr in pat` [Feature #17371] 2020-12-13 11:51:49 +09:00
Hiroshi SHIBATA b084f8abcf Completely removed webrick 2020-12-10 18:06:25 +09:00
Hiroshi SHIBATA 0e73b49b4c Promote webrick to bundled gems 2020-12-10 18:06:25 +09:00
Marc-Andre Lafortune 47ff8de645 Update maintainers list [doc] [ci skip] 2020-12-09 01:03:29 -05:00
Samuel Williams 2553c5f94a Add support for non-blocking `Process.wait`. 2020-12-09 08:55:35 +13:00
Hiroshi SHIBATA 30d4a7ad9a
Update rubygems.org links for publlished default gems. 2020-12-08 21:42:03 +09:00
James Koenig a67cd8a888 -> creates a lambda so this updates the documentation to reflect that 2020-11-30 20:11:18 -05:00
Burdette Lamar 20a9131270 [ruby/csv] RDoc recipes for RFC-compliant generation (#187) 
https://github.com/ruby/csv/commit/5adeaff91f
 2020-11-24 09:33:55 +09:00