Граф коммитов

592 Коммитов

Автор SHA1 Сообщение Дата
Jeremy Evans 59c3b1c9c8 Add section to extension.rdoc for backwards compatibility macros [ci skip]
These macros should make it easier to C extensions to switch to
the Ruby 2.7 C-API *_kw functions, but still have the code work
correctly on older Ruby versions.
2019-10-07 13:51:28 -07:00
Jeremy Evans c0eae130b1 Note RB_PASS_EMPTY_KEYWORDS and RB_SCAN_ARGS_EMPTY_KEYWORDS will be removed
There is no need for these in Ruby 3.0, and the plan is to
remove them.
2019-10-07 13:51:21 -07:00
Jeremy Evans 9f24e8fdbb Document *_kw functions added to include/ruby/ruby.h [ci skip]
Also documents the non-*_kw functions if they were not already
documented.
2019-10-03 14:13:27 -07:00
Jeremy Evans c7715a4936 Add documentation regarding keyword argument separation [ci skip] 2019-10-03 14:13:27 -07:00
Jeremy Evans 12e27a411c Minor updates to methods and calling_methods documentation [ci skip] 2019-10-03 14:13:27 -07:00
Nobuyoshi Nakada 2683171994
[DOC] DOT is not a part of a receiver [ci skip]
[Feature #11297] [Feature #16123]
2019-09-20 16:43:39 +09:00
Hiroshi SHIBATA 9d25c652a9
Removed ThreadsWait from the ruby repository 2019-09-20 14:21:04 +09:00
Hiroshi SHIBATA 37c0839425
Removed Synchronizer from the ruby repository. 2019-09-20 14:06:22 +09:00
Hiroshi SHIBATA 3b56a0934f
Removed Shell from the ruby repository. 2019-09-20 12:56:18 +09:00
Hiroshi SHIBATA 67a6662032
Removed Scanf from the ruby repository. 2019-09-20 12:43:11 +09:00
Hiroshi SHIBATA a3b8501614
Removed CMath from the ruby repository. 2019-09-20 12:31:37 +09:00
Nobuyoshi Nakada b80df6e8e0
Update NEWS and documents [ci skip]
[Feature #11297] [Feature #16123]
2019-09-20 02:40:59 +09:00
Kazuhiro NISHIYAMA 70f57287cf
Fix a typo [ci skip] 2019-09-16 21:36:23 +09:00
Jeremy Evans cd0e208963 Document {n}? regexp pattern is optional and not non-greedy [ci skip]
While not consistent with {n,}?, {,m}?, and {n,m}?, it is arguably
more useful, as otherwise the ? would have no effect.

Fixes [Bug #15583]
2019-08-28 11:50:33 -07:00
Nobuyoshi Nakada 7704bbd640
Marked up command line options [ci skip] 2019-08-16 00:28:22 +09:00
Olivier Lacan 8e7df4bbf9
Use the word heredocs in Here Documents docs
Two advantages:
- higher relevance of the extremely common word "heredocs" which may
help people find this page when searching for "ruby heredocs"
- the anchor link becomes `#label-Here+Documents+-28heredocs-29`, which is
ugly due to the parentheses but includes the word "heredocs" in the URL to
this section

If anyone knows a way to prevent RDoc from turning invalid characters into
ugly and meaningless ASCII codes, I'm listening. I don't want to break existing
anchor links but RDoc should really ignore these characters or turn them into
dashes.

Closes: https://github.com/ruby/ruby/pull/2103
2019-08-04 09:18:48 +09:00
Nobuyoshi Nakada 954223ebd4
[DOC] mentioned minimum versions of tools [ci skip] 2019-08-03 14:56:41 +09:00
Jeremy Evans bd32833382 Document behavior when mixing named captures with parentheses [ci skip]
Fixes [Bug #13716]
2019-07-26 14:26:59 -07:00
Hiroshi SHIBATA ab087ecb4d
Added the upstream repositories to default gems. 2019-07-23 13:34:35 +09:00
Hiroshi SHIBATA 73d56d6fe7
reline is default gems now. 2019-07-23 13:32:21 +09:00
Hiroshi SHIBATA 44cfabddbe
Removed duplicated entry for racc. 2019-07-23 11:20:08 +09:00
Jeremy Evans c945d115a5 Document use of ensure and else at method level [ci skip] 2019-07-19 11:39:05 -07:00
Jeremy Evans ceeb1535dd Remove section on performance advantage of not using a block parameter [ci skip]
Improvements in Ruby 2.5 and 2.6 make this section no longer
accurate.
2019-07-19 11:38:49 -07:00
Jeremy Evans 7e2677675d Remove mention of Proc.new with implicit block [ci skip]
This support is now deprecated and will be removed in Ruby 3.
2019-07-19 11:38:49 -07:00
Jeremy Evans bf2f84b2ff Document evaluation order of arguments [ci skip]
Fixes [Misc #8905]
2019-07-19 11:38:49 -07:00
Jeremy Evans 71d21f3c75 Document required keyword argument syntax [ci skip]
Fixes [Bug #8952]
2019-07-19 11:38:42 -07:00
Kazuhiro NISHIYAMA e644e2de85
Remove doc/etc.rd.ja [ci skip]
[Feature #16003] [ruby-dev:50814]
2019-07-19 09:01:53 +09:00
Kazuhiro NISHIYAMA 62f34bd1fe
doc/globals.rdoc: Add deprecated to TRUE,FALSE,NIL [ci skip]
They are warned since 2.4.0.
2019-07-15 13:59:02 +09:00
Jeremy Evans 99afea5328 Add bug triaging guide
Implements [Misc #15943]
2019-07-14 21:41:12 -07:00
Kazuhiro NISHIYAMA 226d569e57
doc/irb/irb.rd.ja: Update options from `irb -h` [ci skip] 2019-07-15 11:03:24 +09:00
Kazuhiro NISHIYAMA 05cc87df1b
[DOC] Struct::Passwd#uclass renamed from #class at r2500 [ci skip] 2019-07-15 10:53:05 +09:00
Kazuhiro NISHIYAMA d0f113f6c1
doc/globals.rdoc: Add RUBY_REVISION [ci skip] 2019-07-14 22:15:42 +09:00
Kazuhiro NISHIYAMA ab31e13e75
doc/globals.rdoc: Add RUBY_PATCHLEVEL [ci skip] 2019-07-14 22:15:42 +09:00
Kazuhiro NISHIYAMA 9a402cf61f
doc/globals.rdoc: Add RUBY_COPYRIGHT [ci skip] 2019-07-14 22:15:42 +09:00
Kazuhiro NISHIYAMA 5d606b5174
doc/globals.rdoc: Add TOPLEVEL_BINDING [ci skip] 2019-07-14 22:15:42 +09:00
Kazuhiro NISHIYAMA 2618db3011
[DOC] Fix typos [ci skip] 2019-07-14 16:00:34 +09:00
Kazuhiro NISHIYAMA f2d99fd820
[DOC] Fix indent [ci skip] 2019-07-14 15:54:19 +09:00
Kazuhiro NISHIYAMA dda2c860d9
[DOC] Fix link to feature [ci skip] 2019-07-14 14:59:34 +09:00
Kazuhiro NISHIYAMA 6da539be3e
Fix typos [ci skip] 2019-07-14 14:52:31 +09:00
Kazuhiro NISHIYAMA 421dd31145
[DOC] Fix experimental marker [ci skip] 2019-07-14 14:34:32 +09:00
Nobuyoshi Nakada 1a4f7c9bfa
[DOC] Markup code in globals.rdoc
Look forward to further improvements in RDoc to automatically mark
up global variables and global constants.
2019-07-13 23:36:34 +09:00
Benoit Daloze 6ef73c1472 Improve documentation in doc/globals.rdoc 2019-07-13 15:47:37 +02:00
Benoit Daloze 237b3e00c7 Document $~ before dependent global variables 2019-07-13 15:39:54 +02:00
Benoit Daloze b1ee7148f8 Improve documentation of $LOAD_PATH 2019-07-13 15:35:16 +02:00
Benoit Daloze 4a935bc6f6 Document $LOAD_PATH.resolve_feature_path in globals.rdoc
* RDoc does not seem to support documenting singleton object methods,
  and making $LOAD_PATH a class as a workaround is too weird.
2019-07-13 15:23:49 +02:00
Benoit Daloze b0f6f33094 Document a few more RUBY_* constants 2019-07-13 15:16:26 +02:00
Benoit Daloze 43677a2c58 Document the long form of global variables and mention aliases on the same line
* The longer forms are self-explanatory and I believe more often used.
* Same for ARGV and ARGF, describe them there and mention $* and $< just refer to them.
2019-07-13 15:07:19 +02:00
Jeremy Evans a4b5aaa9a7 Remove Changelog section from doc/contributing.rdoc [ci skip]
Replace it with a section on commit message formatting.  Also,
move the section on rebasing to the bottom, since that only
applies to committers and not most contributors.

Fixes [Bug #14886]
2019-07-02 08:22:11 -07:00
Kazuhiro NISHIYAMA 934a3a926c
Prefer master rather than trunk in doc/contributing.rdoc [ci skip] 2019-07-02 09:35:11 +09:00
Kazuhiro NISHIYAMA 73923bf583
[DOC] Add LibreSSL [ci skip] 2019-07-02 09:35:11 +09:00