Skip to content

Fix typos in Reference Manual - #10918

Merged
bjorng merged 1 commit into
erlang:masterfrom
juhlig:fix_reference_manual_typos
Mar 27, 2026
Merged

Fix typos in Reference Manual#10918
bjorng merged 1 commit into
erlang:masterfrom
juhlig:fix_reference_manual_typos

Conversation

@juhlig

@juhlig juhlig commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

This PR fixes some typos and grammar issues, and also rewords some phrases for simplification and/or clarification, in the Reference Manual.

One thing we noticed while doing this (but didn't change) is that there are mixed usages of british and american english (eg "behaviour" vs "behavior"), usually in the prose. Also, there are some spellings that, while not wrong, have fallen out of favor (eg "run-time" vs "runtime").

This PR slightly clashes with #10914, bad timing... Whatever PR gets merged first, the other will probably have to be adapted.

@github-actions

github-actions Bot commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

CT Test Results

  1 files   11 suites   3m 3s ⏱️
 95 tests  91 ✅ 4 💤 0 ❌
111 runs  107 ✅ 4 💤 0 ❌

Results for commit 83ce6b3.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

@IngelaAndin IngelaAndin added the team:VM Assigned to OTP team VM label Mar 25, 2026
@bjorng bjorng self-assigned this Mar 25, 2026

@bjorng bjorng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good to me. I have a few suggestions for further improvements.

Comment thread system/doc/reference_manual/data_types.md Outdated
Comment thread system/doc/reference_manual/data_types.md Outdated
Comment thread system/doc/reference_manual/distributed.md Outdated
Comment thread system/doc/reference_manual/errors.md Outdated
Comment thread system/doc/reference_manual/expressions.md Outdated
Comment thread system/doc/reference_manual/expressions.md Outdated
@bjorng

bjorng commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

Our policy is generally to use American spelling, but we have the -behaviour() attribute. Not sure that we should do this kind of changes now.

Because of the size of this pull request, do any changes as additional commits. I will ask you to squash later when I've reviewed the changes.

@Maria-12648430

Copy link
Copy Markdown
Contributor

@bjorng I applied the suggestions which I think are indisputable and left the ones on which I have questions for later 😉

@juhlig

juhlig commented Mar 25, 2026

Copy link
Copy Markdown
Contributor Author

Our policy is generally to use American spelling, but we have the -behaviour() attribute. Not sure that we should do this kind of changes now.

Not as part of this PR, I think.

Because of the size of this pull request, do any changes as additional commits. I will ask you to squash later when I've reviewed the changes.

Sure 👍

@juhlig
juhlig force-pushed the fix_reference_manual_typos branch from 3b9f1a8 to d53dcd9 Compare March 26, 2026 12:15
@juhlig

juhlig commented Mar 26, 2026

Copy link
Copy Markdown
Contributor Author

@bjorng I applied your suggestions in the last commit.

@juhlig
juhlig requested a review from bjorng March 26, 2026 12:16
@bjorng bjorng added the testing currently being tested, tag is used by OTP internal CI label Mar 26, 2026
Co-authored-by: Maria Scott <maria-12648430@hnc-agency.org>
@bjorng
bjorng force-pushed the fix_reference_manual_typos branch from d53dcd9 to 83ce6b3 Compare March 27, 2026 07:24
@bjorng
bjorng merged commit 868fb4f into erlang:master Mar 27, 2026
27 checks passed
@bjorng

bjorng commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Thanks for your pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team:VM Assigned to OTP team VM testing currently being tested, tag is used by OTP internal CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants