Skip to content

Commit d0d2e77

Browse files
committed
Fix typos in documentation_guide.md
1 parent 14049b1 commit d0d2e77

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/contributing/documentation_guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Use your judgment about what the user needs to know.
6161
Use only US-ASCII-compatible characters in a C source file.
6262
(If you use other characters, the Ruby CI will gently let you know.)
6363

64-
If want to put ASCII-incompatible characters into the documentation
64+
If you want to put ASCII-incompatible characters into the documentation
6565
for a C-coded class, module, or method, there are workarounds
6666
involving new files `doc/*.rdoc`:
6767

@@ -74,7 +74,7 @@ involving new files `doc/*.rdoc`:
7474
class Foo; end
7575
```
7676

77-
- Similarly, for module `Bar` (defined in file `bar.c`,
77+
- Similarly, for module `Bar` (defined in file `bar.c`),
7878
create file `doc/bar.rdoc`, declare `module Bar; end`,
7979
and place the module documentation above that declaration:
8080

@@ -284,7 +284,7 @@ Use a full URL-based link for:
284284
- A link in standard library documentation to documentation in a different
285285
standard library package.
286286

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
288288
is built independently (separately from the core documentation).
289289

290290
The link should lead to a target in https://docs.ruby-lang.org/en/master/.
@@ -484,7 +484,7 @@ Return types:
484484
- If the method can return multiple types, use +object+.
485485
- If the method returns the receiver, use +self+.
486486
- 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+;
488488
example: `new_array`.
489489
490490
Aliases:
@@ -588,7 +588,7 @@ mention `Hash#fetch` as a related method, and `Hash#merge` might mention
588588
`Hash#merge!` as a related method.
589589

590590
- 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,
592592
at the end of the method documentation, add a line starting with
593593
"Related: " (e.g. "Related: #fetch.").
594594
- Don't list more than three related methods.
@@ -597,7 +597,7 @@ mention `Hash#fetch` as a related method, and `Hash#merge` might mention
597597
- Consider adding:
598598

599599
- A phrase suggesting how the related method is similar to,
600-
or different from,the current method.
600+
or different from, the current method.
601601
See an example at Time#getutc.
602602
- Example code that illustrates the similarities and differences.
603603
See examples at Time#ctime, Time#inspect, Time#to_s.

0 commit comments

Comments
 (0)