Skip to content

Documentation improvements#2250

Open
poetinger wants to merge 5 commits into
eclipse-cyclonedds:masterfrom
poetinger:documentation-fixes
Open

Documentation improvements#2250
poetinger wants to merge 5 commits into
eclipse-cyclonedds:masterfrom
poetinger:documentation-fixes

Conversation

@poetinger

@poetinger poetinger commented Jul 23, 2025

Copy link
Copy Markdown
Contributor

Fixes a few minor typos during documentation review.

This now includes more review comment improvements from various sources, all bundled into one PR.

@eboasson eboasson 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.

"behaviour" and "serialisation" aren't so much typo's as English words, whereas "behavior" is mere dialect 🤣:

  • "serialize | ˈsɪərɪəlʌɪz | (British English also serialise)"
  • "behaviour | bɪˈheɪvjə | (behavior US English)"

I do agree there is an undesirable inconsistency in their use (the worst for "serialize"/"serialise"). If Cyclone today straddles the mid-Atlantic ridge and we want to prevent it from being torn apart by the continental drift, we need to choose a side. I would instinctively choose the old world, that goes without saying ...

(Also don't forget the pre-commit check is failing on the CI)

@poetinger

Copy link
Copy Markdown
Contributor Author

"behaviour" and "serialisation" aren't so much typo's as English words, whereas "behavior" is mere dialect 🤣:

  • "serialize | ˈsɪərɪəlʌɪz | (British English also serialise)"
  • "behaviour | bɪˈheɪvjə | (behavior US English)"

I do agree there is an undesirable inconsistency in their use (the worst for "serialize"/"serialise"). If Cyclone today straddles the mid-Atlantic ridge and we want to prevent it from being torn apart by the continental drift, we need to choose a side. I would instinctively choose the old world, that goes without saying ...

(Also don't forget the pre-commit check is failing on the CI)

I will open an issue for this, more thorough, standardization for a future PR. We can pick which side of the Atlantic for this :)

I will update the hashes as well.

@poetinger poetinger requested a review from eboasson July 31, 2025 09:33

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Is this actually correct to delete?

@poetinger poetinger force-pushed the documentation-fixes branch from 9548a75 to 34b37d5 Compare March 10, 2026 10:14
@poetinger poetinger changed the title fix typos Documentation improvements Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants