archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-24 13:34:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
71544 commits 30 branches 1174 tags 512 MiB
Commit graph

165 commits

Author SHA1 Message Date
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
tenderlove
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
nobu
d70a84d5d4 methods.rdoc: closing tag 
* doc/syntax/methods.rdoc (Method Names): add proper closing tag.
  [Fix GH-1356]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@55094 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2016-05-21 02:07:31 +00:00
hsbt
8f8f92b508 * doc/syntax/calling_methods.rdoc: fix old operator for safe navigation 
operator. [ci skip][fix GH-1182] Patch by @dougo

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53385 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-12-30 11:26:09 +00:00
hsbt
4f94cb43fc * doc/syntax/*.rdoc: separated modifier at sentence. 
[ci skip][fix GH-1121] Patch by @clandry94

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53182 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-12-18 03:39:49 +00:00
shugo
6df0853173 * doc/syntax/refinements.rdoc: remove outdated description. 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52993 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-12-09 05:38:31 +00:00
nobu
9a28a29b87 parse.y: indented hereoc 
* parse.y: add heredoc <<~ syntax.  [Feature #9098]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52916 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-12-07 14:39:52 +00:00
shugo
46425732cf * doc/syntax/refinements.rdoc: update documentation to reflect 
recent changes.
  [ci skip] [ruby-core:71466] [Misc #11681] Patch by James Adam

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52629 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-11-18 01:08:19 +00:00
knu
1b5dce5a4e * NEWS: [DOC] In the new safe call syntax, arguments are evaluated 
only if a call is made.

* doc/syntax/calling_methods.rdoc: Fix a typo.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52251 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-10-23 16:53:41 +00:00
nobu
a356fe1c35 Safe navigation operator 
* compile.c (iseq_peephole_optimize): peephole optimization for
  branchnil jumps.
* compile.c (iseq_compile_each): generate save navigation operator
  code.
* insns.def (branchnil): new opcode to pop the tos and branch if
  it is nil.
* parse.y (NEW_QCALL, call_op, parser_yylex): parse token '.?'.
  [Feature #11537]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52214 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-10-22 06:30:12 +00:00
knu
11b804feee [DOC] Remove \0 since it's aprt of octal notation 
A typo is fixed while at it.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51878 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-09-16 06:58:56 +00:00
knu
5ac401c8dc [DOC] \0 is interpreted as NUL only if not followed by an octal digit. 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51877 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-09-16 06:31:39 +00:00
nobu
2b89d63e61 literals.rdoc: add DEL [ci skip] 
* doc/syntax/literals.rdoc (Strings): [DOC] add DEL.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51876 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-09-16 06:21:13 +00:00
knu
6989f24117 [DOC] Revise the character literal part. 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51875 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
 2015-09-16 06:16:15 +00:00