Skip to content

[DOC] Fix typos in documentation files #13949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/contributing/documentation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Use your judgment about what the user needs to know.
Use only US-ASCII-compatible characters in a C source file.
(If you use other characters, the Ruby CI will gently let you know.)

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

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

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

Expand Down Expand Up @@ -284,7 +284,7 @@ Use a full URL-based link for:
- A link in standard library documentation to documentation in a different
standard library package.

Doing so ensures that the link will valid even when the package documentation
Doing so ensures that the link will be valid even when the package documentation
is built independently (separately from the core documentation).

The link should lead to a target in https://docs.ruby-lang.org/en/master/.
Expand Down Expand Up @@ -484,7 +484,7 @@ Return types:
- If the method can return multiple types, use +object+.
- If the method returns the receiver, use +self+.
- If the method returns an object of the same class,
prefix `new_` if an only if the object is not +self+;
prefix `new_` if and only if the object is not +self+;
example: `new_array`.

Aliases:
Expand Down Expand Up @@ -588,7 +588,7 @@ mention `Hash#fetch` as a related method, and `Hash#merge` might mention
`Hash#merge!` as a related method.

- Consider which methods may be related
to the current method, and if you think the reader would benefit it,
to the current method, and if you think the reader would benefit from it,
at the end of the method documentation, add a line starting with
"Related: " (e.g. "Related: #fetch.").
- Don't list more than three related methods.
Expand All @@ -597,7 +597,7 @@ mention `Hash#fetch` as a related method, and `Hash#merge` might mention
- Consider adding:

- A phrase suggesting how the related method is similar to,
or different from,the current method.
or different from, the current method.
See an example at Time#getutc.
- Example code that illustrates the similarities and differences.
See examples at Time#ctime, Time#inspect, Time#to_s.
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/making_changes_to_stdlibs.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ bundle exec rake test TEST="test/test_foo.rb"
To run a single test case:

```shell
bundle exec rake test TEST="test/test_foo.rb" TESTOPS="--name=/test_mytest/"
bundle exec rake test TEST="test/test_foo.rb" TESTOPTS="--name=/test_mytest/"
```
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy