Skip to content

docs: fix typos and grammar across documentation and source#471

Open
Technocrat-dev wants to merge 1 commit intomercari:mainfrom
Technocrat-dev:docs/fix-typos-and-grammar
Open

docs: fix typos and grammar across documentation and source#471
Technocrat-dev wants to merge 1 commit intomercari:mainfrom
Technocrat-dev:docs/fix-typos-and-grammar

Conversation

@Technocrat-dev
Copy link
Copy Markdown

What this PR does / why we need it:

Fixes a few typos and grammar errors I found while reading through the docs and source comments.

Changes:

  • api/v1beta3/tortoise_types.go: "toet" -> "to let" in CrossVersionObjectReference comment
  • docs/horizontal.md: Completed the cut-off section header "### How Tortoise" -> "### How Tortoise calculates the recommendations"
  • docs/horizontal.md: "to some extend" -> "to some extent"
  • docs/contributor-guide.md: "developping" -> "developing"
  • README.md: "adapts" -> "adapt" (subject-verb agreement, since "all Tortoises" is plural)

Which issue(s) this PR fixes:

N/A (typo/grammar fixes, no issue needed)

Special notes

This is my first contribution to this project. All changes are in docs and comments only, no logic changes.

One thing I noticed but didn't change: in docs/horizontal.md Examples 3 and 4 (lines 171, 179, 199, 207, 211), replicas of 3 are described as "the same as PreferredMaxReplicas", but looking at the context (the section is about reaching the minimum replicas, and MinimumMinReplicas is 3), I think these should say MinimumMinReplicas instead. Left them as-is since I wasn't 100% sure, but wanted to flag it.

- Fix 'toet' to 'to let' in CrossVersionObjectReference comment
- Complete incomplete section header in horizontal.md
- Fix 'to some extend' to 'to some extent' in horizontal.md
- Fix 'developping' to 'developing' in contributor-guide.md
- Fix subject-verb agreement 'adapts' to 'adapt' in README.md
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.

1 participant