Skip to content

Commit 2e86ea3

Browse files
committed
Merge pull request #378 from sethkrasnianski/sjk/method-verbiage
Changed incorrect instances of 'arguments' to 'parameters'
2 parents ec660ca + cf0d2be commit 2e86ea3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,8 @@ Translations of the guide are available in the following languages:
624624
```
625625

626626
* <a name="method-parens"></a>
627-
Use `def` with parentheses when there are arguments. Omit the
628-
parentheses when the method doesn't accept any arguments.
627+
Use `def` with parentheses when there are parameters. Omit the
628+
parentheses when the method doesn't accept any parameters.
629629
<sup>[[link](#method-parens)]</sup>
630630

631631
```Ruby
@@ -640,12 +640,12 @@ Translations of the guide are available in the following languages:
640640
end
641641

642642
# bad
643-
def some_method_with_arguments arg1, arg2
643+
def some_method_with_parameters param1, param2
644644
# body omitted
645645
end
646646

647647
# good
648-
def some_method_with_arguments(arg1, arg2)
648+
def some_method_with_parameters(param1, param2)
649649
# body omitted
650650
end
651651
```
@@ -1925,7 +1925,7 @@ condition](#safe-assignment-in-condition).
19251925
<sup>[[link](#reduce-blocks)]</sup>
19261926

19271927
* <a name="other-arg"></a>
1928-
When defining binary operators, name the argument `other`(`<<` and `[]` are
1928+
When defining binary operators, name the parameter `other`(`<<` and `[]` are
19291929
exceptions to the rule, since their semantics are different).
19301930
<sup>[[link](#other-arg)]</sup>
19311931

@@ -3299,11 +3299,11 @@ condition](#safe-assignment-in-condition).
32993299
UNSAFE_STRING_METHODS.each do |unsafe_method|
33003300
if 'String'.respond_to?(unsafe_method)
33013301
class_eval <<-EOT, __FILE__, __LINE__ + 1
3302-
def #{unsafe_method}(*args, &block) # def capitalize(*args, &block)
3302+
def #{unsafe_method}(*params, &block) # def capitalize(*params, &block)
33033303
to_str.#{unsafe_method}(*args, &block) # to_str.capitalize(*args, &block)
33043304
end # end
33053305

3306-
def #{unsafe_method}!(*args) # def capitalize!(*args)
3306+
def #{unsafe_method}!(*params) # def capitalize!(*params)
33073307
@dirty = true # @dirty = true
33083308
super # super
33093309
end # end
@@ -3327,7 +3327,7 @@ condition](#safe-assignment-in-condition).
33273327

33283328
```ruby
33293329
# bad
3330-
def method_missing?(meth, *args, &block)
3330+
def method_missing?(meth, *params, &block)
33313331
if /^find_by_(?<prop>.*)/ =~ meth
33323332
# ... lots of code to do a find_by
33333333
else
@@ -3336,7 +3336,7 @@ condition](#safe-assignment-in-condition).
33363336
end
33373337

33383338
# good
3339-
def method_missing?(meth, *args, &block)
3339+
def method_missing?(meth, *params, &block)
33403340
if /^find_by_(?<prop>.*)/ =~ meth
33413341
find_by(prop, *args, &block)
33423342
else
@@ -3411,7 +3411,7 @@ condition](#safe-assignment-in-condition).
34113411
Code in a functional way, avoiding mutation when that makes sense.
34123412
<sup>[[link](#functional-code)]</sup>
34133413

3414-
* <a name="no-arg-mutations"></a>
3414+
* <a name="no-param-mutations"></a>
34153415
Do not mutate arguments unless that is the purpose of the method.
34163416
<sup>[[link](#no-arg-mutations)]</sup>
34173417

0 commit comments

Comments
 (0)