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

578 Коммитов

Автор SHA1 Сообщение Дата
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
Kazuhiro NISHIYAMA 1235e054eb
[DOC] Add spaces [ci skip] 2019-06-26 21:44:42 +09:00
Kazuhiro NISHIYAMA d9a055a721
[DOC] Fix svn account [ci skip] 2019-06-26 21:44:20 +09:00
Jeremy Evans 0f28094201 Improve wording of Local Variables and eval section
As pointed out by nobu, "defined" should be used instead of "assigned".
2019-06-25 11:18:08 -07:00
git dd57442f74 * remove trailing spaces. 2019-06-26 01:53:19 +09:00
Jeremy Evans 0bd5f846df Document local variable interactions with eval
Fixes [Bug #13337]
2019-06-25 09:52:34 -07:00
Hiroshi SHIBATA 3aa8691d52 Added and update the racc entries on doc/*. 2019-06-20 16:11:03 +09:00
Kazuhiro NISHIYAMA e6aa0a61fa
[DOC] non-nil `$,`,`$;` will be deprecated [ci skip]
```
% ruby -e '$,=""; $;=""'
-e:1: warning: non-nil $, will be deprecated
-e:1: warning: non-nil $; will be deprecated
```
2019-06-18 17:31:42 +09:00
Kazuhiro NISHIYAMA f48aad7ba2
Add reline to doc/maintainers.rdoc 2019-06-03 10:47:38 +09:00
Jeremy Evans 560cd5b1f0 Add myself as OpenBSD platform maintainer 2019-06-01 00:52:40 -07:00
aycabta 3a9008b984 Add --colorize and --nocolorize options to IRB 2019-05-21 08:57:21 +09:00
Marcus Stollsteimer 1f349ea297 Fix typo 2019-05-03 16:12:22 +02:00
aycabta 94b740b249 Use Ripper for IRB
The debug option of IRB is deleted because it's just for IRB's pure Ruby
parser.
2019-04-30 14:40:06 +09:00
Nobuyoshi Nakada 1432471a75
Disallow also CR in here-doc identifier
* parse.y (heredoc_identifier): CR in here-document identifier
  might or might not result in a syntax error, by the EOL code.
  make a syntax error regardless of the EOL code.
2019-04-29 13:47:20 +09:00
Nobuyoshi Nakada 330b376133
parse.y: fix here-doc identifier with newline
* parse.y (heredoc_identifier): quoted here-document identifier
  must end within the same line.

  the only corner case that here-document identifier can contain a
  newline is that the closing qoute is placed at the beginning of
  the next line, and has been warned since 2.4.

  ```ruby
  <<"EOS
  " # warning: here document identifier ends with a newline
  EOS
  ```
2019-04-29 12:49:59 +09:00