@@ -61,7 +61,7 @@ Use your judgment about what the user needs to know.
61
61
Use only US-ASCII-compatible characters in a C source file.
62
62
(If you use other characters, the Ruby CI will gently let you know.)
63
63
64
- If want to put ASCII-incompatible characters into the documentation
64
+ If you want to put ASCII-incompatible characters into the documentation
65
65
for a C-coded class, module, or method, there are workarounds
66
66
involving new files ` doc/*.rdoc ` :
67
67
@@ -74,7 +74,7 @@ involving new files `doc/*.rdoc`:
74
74
class Foo ; end
75
75
```
76
76
77
- - Similarly , for module ` Bar` (defined in file ` bar.c` ,
77
+ - Similarly , for module ` Bar` (defined in file ` bar.c` ) ,
78
78
create file ` doc/bar.rdoc` , declare ` module Bar; end` ,
79
79
and place the module documentation above that declaration:
80
80
@@ -284,7 +284,7 @@ Use a full URL-based link for:
284
284
- A link in standard library documentation to documentation in a different
285
285
standard library package.
286
286
287
- Doing so ensures that the link will valid even when the package documentation
287
+ Doing so ensures that the link will be valid even when the package documentation
288
288
is built independently (separately from the core documentation).
289
289
290
290
The link should lead to a target in https: // docs.ruby- lang.org/ en/ master/ .
@@ -484,7 +484,7 @@ Return types:
484
484
- If the method can return multiple types, use +object+.
485
485
- If the method returns the receiver, use +self+.
486
486
- If the method returns an object of the same class,
487
- prefix `new_` if an only if the object is not +self+;
487
+ prefix `new_` if and only if the object is not +self+;
488
488
example: `new_array`.
489
489
490
490
Aliases:
@@ -588,7 +588,7 @@ mention `Hash#fetch` as a related method, and `Hash#merge` might mention
588
588
` Hash#merge! ` as a related method.
589
589
590
590
- Consider which methods may be related
591
- to the current method, and if you think the reader would benefit it,
591
+ to the current method, and if you think the reader would benefit from it,
592
592
at the end of the method documentation, add a line starting with
593
593
"Related: " (e.g. "Related: #fetch.").
594
594
- Don't list more than three related methods.
@@ -597,7 +597,7 @@ mention `Hash#fetch` as a related method, and `Hash#merge` might mention
597
597
- Consider adding:
598
598
599
599
- A phrase suggesting how the related method is similar to,
600
- or different from,the current method.
600
+ or different from, the current method.
601
601
See an example at Time#getutc.
602
602
- Example code that illustrates the similarities and differences.
603
603
See examples at Time#ctime, Time#inspect, Time#to_s.
0 commit comments