Skip to content

Fix typos in comments and documentation#566

Open
maxtaran2010 wants to merge 1 commit into
tikv:masterfrom
maxtaran2010:fix-typos
Open

Fix typos in comments and documentation#566
maxtaran2010 wants to merge 1 commit into
tikv:masterfrom
maxtaran2010:fix-typos

Conversation

@maxtaran2010

@maxtaran2010 maxtaran2010 commented Jul 9, 2026

Copy link
Copy Markdown

Fix a few spelling mistakes found by codespell:

  • equivalantequivalent in src/pulling_gauge.rs
  • staticlystatically in src/lib.rs and static-metric/src/lib.rs
  • recievedreceived in static-metric/src/lib.rs
  • reccomendedrecommended in static-metric/src/lib.rs

Summary by CodeRabbit

  • Documentation
    • Corrected several typos and wording issues in crate and API documentation.
    • Improved example text and formatting for clearer, more polished reading.
    • Updated descriptions to use consistent terminology around statically built metrics.

Fix spelling mistakes found by codespell: equivalant->equivalent,
staticly->statically, recieved->received, reccomended->recommended.
Copilot AI review requested due to automatic review settings July 9, 2026 22:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@ti-chi-bot

ti-chi-bot Bot commented Jul 9, 2026

Copy link
Copy Markdown

Welcome @maxtaran2010! It looks like this is your first PR to tikv/rust-prometheus 🎉

@ti-chi-bot

ti-chi-bot Bot commented Jul 9, 2026

Copy link
Copy Markdown

Thanks for your pull request. Before we can look at it, you'll need to add a 'DCO signoff' to your commits.

📝 Please follow instructions in the contributing guide to update your commits with the DCO

Full details of the Developer Certificate of Origin can be found at developercertificate.org.

The list of commits missing DCO signoff:

  • 9abb7d4 Fix typos in comments and documentation
Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Corrects spelling and formatting errors in crate-level, type-level, and example documentation. No functional code, public declarations, APIs, or behavior changed.

Changes

Documentation corrections

Layer / File(s) Summary
Rustdoc wording and examples
src/lib.rs, src/pulling_gauge.rs, static-metric/src/lib.rs
Corrects spelling errors in crate and PullingGauge documentation, updates the example label text, and fixes surrounding code-fence formatting.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the change: spelling fixes in comments and documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants