Corrected typos #1046
Corrected typos #1046
Conversation
WalkthroughThis pull request introduces a series of typographical corrections across documentation, code comments, and test files. Changes include fixing misspelled words in the changelog, performance guide, and README, as well as updating comments within the source and test files. No functional behavior or public API changes have been made. Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
PERFORMANCE.md (1)
26-28: Refine list formatting and abbreviation usage.
The dependency management line now correctly uses “dependency” instead of “dependeny.” Additionally, consider:
- Changing “etc” to “etc.” to fully conform to American English abbreviation conventions.
- Verifying the unordered list indentation complies with markdownlint (MD007) guidelines, which suggest adjusting the list marker indentation.
A suggested diff for the abbreviation fix:- * Fixed up dependency management (tmlibs/db etc in glide/vendor) + * Fixed up dependency management (tmlibs/db etc. in glide/vendor)🧰 Tools
🪛 LanguageTool
[style] ~26-~26: In American English, abbreviations like “etc.” require a period.
Context: ...xed up dependency management (tmlibs/db etc in glide/vendor) * Updated Makefile (...(ETC_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
26-26: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
CHANGELOG.md(1 hunks)PERFORMANCE.md(1 hunks)cmd/iaviewer/README.md(1 hunks)immutable_tree.go(1 hunks)iterator.go(1 hunks)mutable_tree_test.go(2 hunks)testutils_test.go(1 hunks)v2/iterator.go(1 hunks)
✅ Files skipped from review due to trivial changes (6)
- iterator.go
- v2/iterator.go
- cmd/iaviewer/README.md
- testutils_test.go
- immutable_tree.go
- mutable_tree_test.go
🧰 Additional context used
🪛 LanguageTool
PERFORMANCE.md
[style] ~26-~26: In American English, abbreviations like “etc.” require a period.
Context: ...xed up dependency management (tmlibs/db etc in glide/vendor) * Updated Makefile (...
(ETC_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
PERFORMANCE.md
26-26: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🔇 Additional comments (2)
CHANGELOG.md (2)
115-115: Corrected version header typo.
You've updated the version header from “Februrary” to “February,” which now correctly reflects the intended date.
119-119: Corrected spelling in bug fix description.
The phrase “nil arguements” has been corrected to “nil arguments,” improving clarity in the changelog entry.
Changes made in:
/CHANGELOG.md ("Februrary" → "February")
/CHANGELOG.md ("arguements" → "arguments")
/PERFORMANCE.md ("dependeny" → "dependency")
/cmd/iaviewer/README.md ("offical" → "official")
/immutable_tree.go ("stategy" → "strategy")
/iterator.go ("remaning" → "remaining, renaming, remaking")
/mutable_tree_test.go ("behing" → "behind, being")
/mutable_tree_test.go ("iteraton" → "iteration")
/testutils_test.go ("desribed" → "described")
/v2/iterator.go ("relasing" → "releasing")
Summary by CodeRabbit
Documentation
Style
Tests