Skip to content

Conversation

mathstuf
Copy link
Contributor

@mathstuf mathstuf commented May 25, 2025

Summary by CodeRabbit

  • Documentation
    • Corrected various typographical errors and improved formatting across multiple documentation pages, guides, and blog posts for enhanced readability and clarity.
    • Made minor capitalization and whitespace adjustments to ensure consistency.
    • No changes to code examples, logic, or functionality.

@mathstuf mathstuf marked this pull request as ready for review May 25, 2025 15:56
Copy link

coderabbitai bot commented May 25, 2025

Walkthrough

This update consists of minor corrections to typographical errors, formatting, and capitalization across multiple documentation and blog files. No code, logic, or control flow changes were made; all modifications are limited to textual improvements for clarity, accuracy, and readability.

Changes

File(s) Change Summary
website/advanced/faq.md Fixed typo: "scneario" → "scenario".
website/blog/new-ver-38.md Fixed typo: "lables" → "labels".
website/blog/optimize-ast-grep.md Fixed typo: "optimzation" → "optimization".
website/blog/stars-6000.md Fixed typo: "espeically" → "especially".
website/blog/typed-napi.md Capitalization fix: "e.g." → "E.g." at sentence start.
website/catalog/python/recursive-rewrite-type.md Fixed typos: "non-recurisve" → "non-recursive", "unioins" → "unions".
website/catalog/python/refactor-pytest-fixtures.md Fixed typo: "straghtforward" → "straightforward".
website/catalog/typescript/find-import-identifiers.md Whitespace and comment formatting cleanup; no logic changes.
website/guide/project/lint-rule.md Capitalization fix: "meta-variables" → "Meta-variables".
website/guide/rewrite-code.md Fixed typo: "trivias" → "trivials".
website/guide/rewrite/transform.md Fixed typo: "illustring" → "illustrating".
website/reference/rule.md Fixed typo: "deep div doc" → "deep dive doc".
website/reference/sgconfig.md Fixed typos: "undert" → "under", "Simliar" → "Similar".
website/reference/yaml.md Fixed typo: "includ" → "include".

Possibly related PRs

Suggested reviewers

  • HerringtonDarkholme

Poem

A hop, a skip, a leap so small,
We fixed the words, both big and small.
No logic changed, just clearer lines,
Our docs now shine, the grammar fine.
🐇✏️ With every typo we defeat,
The garden of knowledge grows more neat!


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
website/blog/new-ver-38.md (1)

37-37: Fix verb agreement for third-person singular.
The sentence reads "it allow you", which should be "it allows you".

- But the benefits don't stop at individual understanding. The labels field offers a fantastic way to embed more guidance directly into your rules, and it allow you to share coding best practices, style guide reminders, or domain-specific knowledge across your entire team.
+ But the benefits don't stop at individual understanding. The labels field offers a fantastic way to embed more guidance directly into your rules, and it allows you to share coding best practices, style guide reminders, or domain-specific knowledge across your entire team.
🧰 Tools
🪛 LanguageTool

[grammar] ~37-~37: After ‘it’, use the third-person verb form “allows”.
Context: ...idance directly into your rules, and it allow you to share coding best practices, sty...

(IT_VBZ)

website/blog/optimize-ast-grep.md (1)

117-117: Typo fix correct; refine grammar and article usage.

The correction of “optimzation” → “optimization” is accurate. Additionally, consider tightening the sentence and adjusting the article:

- I have already forsee it so every rule in ast-grep has an optimization called `potential_kinds`. AST node in tree-sitter has its own type encoded in a unsigned number called `kind`.
+ I had already foreseen it, so every rule in ast-grep has an optimization called `potential_kinds`. AST node in tree-sitter has its own type encoded in an unsigned number called `kind`.
  • Change “I have already forsee it” → “I had already foreseen it,”
  • Use “an unsigned number” instead of “a unsigned number”
🧰 Tools
🪛 LanguageTool

[uncategorized] ~117-~117: Possible missing comma found.
Context: ...ly make a match. I have already forsee it so every rule in ast-grep has an optimi...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~117-~117: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...tree-sitter has its own type encoded in a unsigned number called kind. If a rul...

(EN_A_VS_AN)

website/catalog/python/recursive-rewrite-type.md (1)

12-12: Confirm spelling correction for “non-recursive”
Great catch fixing the typo. For smoother readability, consider adding “a” so it reads “using a non-recursive rewriter.”

🧰 Tools
🪛 LanguageTool

[uncategorized] ~12-~12: You might be missing the article “a” here.
Context: ...te rewriting loop. So if you are using non-recursive rewriter like [this](https://...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aeef565 and e114ae6.

⛔ Files ignored due to path filters (9)
  • website/public/parsers/tree-sitter-c.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-css.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-elixir.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-go.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-json.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-rust.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-swift.wasm is excluded by !**/*.wasm
  • website/public/parsers/tree-sitter-tsx.wasm is excluded by !**/*.wasm
  • website/public/tree-sitter.wasm is excluded by !**/*.wasm
📒 Files selected for processing (14)
  • website/advanced/faq.md (1 hunks)
  • website/blog/new-ver-38.md (1 hunks)
  • website/blog/optimize-ast-grep.md (1 hunks)
  • website/blog/stars-6000.md (1 hunks)
  • website/blog/typed-napi.md (1 hunks)
  • website/catalog/python/recursive-rewrite-type.md (1 hunks)
  • website/catalog/python/refactor-pytest-fixtures.md (1 hunks)
  • website/catalog/typescript/find-import-identifiers.md (8 hunks)
  • website/guide/project/lint-rule.md (1 hunks)
  • website/guide/rewrite-code.md (1 hunks)
  • website/guide/rewrite/transform.md (1 hunks)
  • website/reference/rule.md (1 hunks)
  • website/reference/sgconfig.md (2 hunks)
  • website/reference/yaml.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/blog/stars-6000.md

[style] ~96-~96: Consider using “each one”.
Context: ...s](/image/blog/sponsor2.png) We thank each and every one of you, especially ast-grep's sponsors,...

(EACH_AND_EVERY)

website/blog/new-ver-38.md

[grammar] ~37-~37: After ‘it’, use the third-person verb form “allows”.
Context: ...idance directly into your rules, and it allow you to share coding best practices, sty...

(IT_VBZ)

website/catalog/python/recursive-rewrite-type.md

[uncategorized] ~12-~12: You might be missing the article “a” here.
Context: ...te rewriting loop. So if you are using non-recursive rewriter like [this](https://...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

website/blog/optimize-ast-grep.md

[uncategorized] ~117-~117: Possible missing comma found.
Context: ...ly make a match. I have already forsee it so every rule in ast-grep has an optimi...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~117-~117: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...tree-sitter has its own type encoded in a unsigned number called kind. If a rul...

(EN_A_VS_AN)

🔇 Additional comments (18)
website/blog/stars-6000.md (1)

96-96: Typo correction is accurate.
Excellent catch fixing "espeically" → "especially".

🧰 Tools
🪛 LanguageTool

[style] ~96-~96: Consider using “each one”.
Context: ...s](/image/blog/sponsor2.png) We thank each and every one of you, especially ast-grep's sponsors,...

(EACH_AND_EVERY)

website/blog/typed-napi.md (1)

173-173: Consistent capitalization for sentence start.
Capitalizing "E.g." at the beginning of a sentence improves readability.

website/guide/rewrite/transform.md (1)

13-13: Corrected spelling of "illustrating".
Good catch fixing "illustring" to "illustrating".

website/catalog/python/refactor-pytest-fixtures.md (1)

34-34: Corrected spelling of "straightforward".
The typo "straghtforward" has been fixed to "straightforward".

website/reference/rule.md (1)

46-46: Typo fix looks good.

The phrase “deep dive doc” is now correct and the link remains accurate.

website/reference/yaml.md (1)

34-34: Typo fix looks good.

Corrected “includ” to “include” in the description of the language field.

website/advanced/faq.md (1)

200-200: Typo fix looks good.

Corrected “scneario” to “scenario” in the FAQ header.

website/guide/project/lint-rule.md (1)

169-169: Capitalization fix is correct.

“Meta-variables” is now properly capitalized to match the surrounding documentation style.

website/reference/sgconfig.md (1)

55-55: Approve spelling correction in documentation
The typo “undert” was correctly fixed to “under” in the description of snapshotDir.

website/catalog/python/recursive-rewrite-type.md (1)

14-14: Approve typo fix
The spelling and formatting of the descriptive text have been corrected appropriately.

website/guide/rewrite-code.md (1)

176-176: Approve typo fix for “trivials”
Corrected “trivias” to “trivials” in the context explanation, improving clarity.

website/catalog/typescript/find-import-identifiers.md (7)

62-62: Approve whitespace cleanup
Trailing spaces and unnecessary blank lines were removed; no semantic changes.


82-82: Approve whitespace cleanup
Trailing spaces and unnecessary blank lines were removed; no semantic changes.


108-108: Approve whitespace cleanup
Trailing spaces and unnecessary blank lines were removed; no semantic changes.


139-139: Approve whitespace cleanup
Trailing spaces and unnecessary blank lines were removed; no semantic changes.


180-180: Approve whitespace cleanup
Trailing spaces and unnecessary blank lines were removed; no semantic changes.


201-201: Approve whitespace cleanup
Trailing spaces and unnecessary blank lines were removed; no semantic changes.


292-292: Approve whitespace cleanup in example
Removed trailing spaces in the import example; formatting is now consistent.

@HerringtonDarkholme HerringtonDarkholme added this pull request to the merge queue May 25, 2025
Merged via the queue into ast-grep:main with commit 4cea9cf May 25, 2025
1 check passed
@mathstuf mathstuf deleted the fix-typos branch May 26, 2025 07:47
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.

2 participants