mirrors/ruby
0
0 Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-10-29 08:55:35 +08:00
Code Activity
63,238 Commits 34 Branches 1,200 Tags
4de32b3556f9bc7ac11d8bcf80bdd9d4794de416
Commit Graph
127 Commits
Author SHA1 Message Date
Jeremy Evans 021cec938a Clarify behavior of super in method in module included in refinement [ci skip] 
Fixes [Bug #16977]
 2020-07-10 15:31:51 -07:00
Burdette Lamar 24739c62e5 [ci skip] Rdoc enhancements for Array (#3063) 
* Per @nobu review

* Rdoc enhancements for Array

* Responses to review
 2020-05-15 14:12:40 -07:00
Kazuhiro NISHIYAMA 5257a53090 Removed NIL/TRUE/FALSE from documents too 
This is follow up of 62554ca978
 2020-04-17 17:40:57 +09:00
Kazuki Tsujimoto cab9788e0c Fix typos 2020-04-05 12:15:18 +09:00
zverok 33260d404f Enhance pattern matching introduction 2020-04-04 23:16:49 +09:00
Jeremy Evans f991340e07 Document defined? and global_variables handling of regexp global variables [ci skip] 
Fixes [Bug #11304]
 2020-03-06 13:06:49 -08:00
zverok 281b350058 Add pattern matching documentation 
Add separate doc/syntax/pattern_matching.rdoc, add
link to control_expressions.rdoc.

The documentation is "reverse-engineered" from Ruby 2.7
behavior and early preview presentations, and corrected
by pattern-matching feature author @k-tsj.
 2020-02-24 00:28:13 +09:00
Adam Isom 09271acdaf Update documentation for Array/Hash Argument section of methods.rdoc 2020-01-17 19:50:39 +09:00
Takashi Kokubun afd3f64f8c Redmine /projects/ruby-trunk is now redirected 
to /projects/ruby-master
 2019-12-31 22:06:19 -08:00
Marcus Stollsteimer 66e518f7b3 [DOC] Fix typo 2019-12-24 13:01:24 +01:00
zverok a4b99f9764 Fix typos of previous docs PR 
In #2612 I made two typos (extra ,, and copy-pasted
same line of code instead of showing two different
ones), fixing them.
 2019-12-23 08:36:58 +09:00
zverok e568bb5649 Update private visibility explanation 2019-12-22 23:17:39 +09:00
Nobuyoshi Nakada db16629008 Fixed misspellings 
Fixed misspellings reported at [Bug #16437], only in ruby and rubyspec.
 2019-12-20 09:32:42 +09:00
zverok bddb31bb37 Documentation improvements for Ruby core 
* Top-level `return`;
* Documentation for comments syntax;
* `rescue` inside blocks;
* Enhance `Object#to_enum` docs;
* Make `chomp:` option more obvious for `String#each_line` and
  `#lines`;
* Enhance `Proc#>>` and `#<<` docs;
* Enhance `Processs` class docs.
 2019-10-26 14:58:08 +09:00
Jeremy Evans 29c1e9a0d4 Document the difference between expressions and statements [ci skip] 
In the grammar, all expressions are statements, but not all
statements are expressions.  Some parts of the grammar accept
expressions and not other types of statements, which causes
similar looking code to parse differently due to operator
precedence.

Mostly from Dan0042 (Daniel DeLorme).

Fixes [Bug #16092]
 2019-10-10 13:45:19 -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
Nobuyoshi Nakada b80df6e8e0 Update NEWS and documents [ci skip] 
[Feature #11297] [Feature #16123]
 2019-09-20 02:40:59 +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
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
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
Marcus Stollsteimer 1f349ea297 Fix typo 2019-05-03 16:12:22 +02: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
mame 95f7992b89 Introduce beginless range [Feature#14799] 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@67422 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2019-04-03 08:11:41 +00:00
tenderloveandVladimir Dementyev d95b13ead1 Update refinements docs 
Co-Authored-By: Vladimir Dementyev <dementiev.vm@gmail.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66788 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2019-01-10 17:28:13 +00:00
stomar 014a9e0587 Small improvement in refinements docs 
Move general statement about refinements of modules
from example to the top of the document.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66530 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2018-12-24 21:14:38 +00:00
marcandre 296bd00e02 range.c: Documentation on endless ranges. 
Based on patch by Victor Shepelev [DOC] [#7552]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66369 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2018-12-12 19:49:22 +00:00
nobu 077a15c829 [DOC] rational and imaginary literals [ci skip] 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@65773 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2018-11-17 01:21:18 +00:00
aycabta ecc627b20a Improve safe navigation operator's docs [Misc #15109] 
* doc/syntax/calling_methods.rdoc: Add Safe navigation operator section.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@65228 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2018-10-20 10:57:33 +00:00
hsbt b0d1586fa7 [DOC] Refinements on modules are allowed 
From: Leo Correa <lcorr005@gmail.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62108 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2018-01-30 07:08:53 +00:00
hsbt 9c650ee3a7 Fix typos. 
* doc/contributors.rdoc: pathces -> patches.
 * doc/syntax/refinements.rdoc: exmaple -> example.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@61761 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2018-01-10 14:13:06 +00:00
stomar 80e852d8a1 doc/syntax/refinements.rdoc: fix typos 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@61088 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-12-08 22:51:42 +00:00
shugo 476f9b6388 Specify refinement inheritance by Module#include. 
[ruby-core:79880] [Bug #13271]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60992 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-12-03 08:35:44 +00:00
stomar 093aa9ae03 refinements.rdoc: improve docs 
* doc/syntax/refinements.rdoc: [DOC] fix typos and grammar
  and remove superfluous "for the first time".

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60700 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-11-07 20:04:58 +00:00
rhe 171f968d22 doc/syntax/methods.rdoc: fix a misleading example 
As a bonus, wrap a long line added by r60295.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60346 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-10-22 04:19:03 +00:00
svn cd381d8acc * remove trailing spaces. 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60296 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-10-21 15:19:46 +00:00
hsbt 86f1d9b705 Clarify return value for assignment methods. 
https://github.com/ruby/ruby/pull/1682

  Patch by @sos4nt [fix GH-1682]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60295 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-10-21 15:19:45 +00:00
nobu 6dc924b606 refinements.rdoc: [DOC] improved [Fix GH-1659] 
* doc/syntax/refinements.rdocrefinements.rdoc: grammatical
  correction and code highlighting improved

* doc/syntax/refinements.rdocrefinements.rdoc: Fixnum replaced
  with Integer and Integer with Numeric

Author:    Shiva Bhusal <shivabhusal@users.noreply.github.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59147 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-06-23 00:29:45 +00:00
stomar 46eed7b80b methods.rdoc: small improvements 
* doc/syntax/methods.rdoc: [DOC] small improvements: fix some typos,
  grammar, punctuation, consistently use capitalized "Ruby".

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58215 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-03-29 19:12:01 +00:00
normal 90fdfec11a doc: Fix error for escape sequences in string literals 
Backslash goes first in escape sequences, so it must be
"any other character following a backslash is interpreted as ...",
while the doc says "...followed by...".

Author: Marcus Stollsteimer <sto.mar@web.de>
[ruby-core:79418] [Bug #13190]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57517 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2017-02-03 23:34:48 +00:00
hsbt 377f69e4fe * doc/syntax/control_expressions.rdoc: Add missing 'as' 
[ci skip][fix GH-1448] Patch by @jsyeo

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56297 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2016-09-30 09:43:24 +00:00
kazu 07efce075b Use https instead of http in some URLs 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56135 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2016-09-11 10:33:36 +00:00