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
Burdette Lamar
d48e688f64
[ruby/csv] RDoc recipes for diagnostics ( #186 )
...
https://github.com/ruby/csv/commit/d9e67918e2
2020-11-24 09:33:55 +09:00
Burdette Lamar
9266410c7a
[ruby/csv] RDoc Recipes for write converters and RFC 4180 compliance ( #185 )
...
https://github.com/ruby/csv/commit/bee48b04c4
2020-11-24 09:33:55 +09:00
Burdette Lamar
c5fcafd2fd
[ruby/csv] Split recipes into three pages: parsing, generating, filtering ( #184 )
...
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
https://github.com/ruby/csv/commit/f0bab6a592
2020-11-24 09:33:55 +09:00
Burdette Lamar
3cfb63fcd8
[ruby/csv] More on Recipes headers ( #183 )
...
https://github.com/ruby/csv/commit/d7ae3df801
2020-11-24 09:33:55 +09:00
Burdette Lamar
15e457d6a3
[ruby/csv] Refine RDoc for headers recipes ( #182 )
...
https://github.com/ruby/csv/commit/bd8085e126
2020-11-24 09:33:55 +09:00