Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix grammar using typos #520

Merged
merged 1 commit into from
Feb 18, 2025
Merged

Conversation

MindTooth
Copy link
Contributor

@MindTooth MindTooth commented Feb 17, 2025

I noticed your latest commit and it had a type in it, so I fired up typos and found some more.

Also, there is a typo on a function itself:

Screenshot 2025-02-17 at 21 52 01

Is it safe to rename the function too?

I noticed however, typos does not seem to catch all. E.g. directoty it did not detect.

Summary by CodeRabbit

  • Bug Fixes
    • Corrected several grammatical errors in error messages and prompts to enhance clarity.
  • Documentation
    • Updated text and formatting throughout user-facing documentation for improved readability and consistency.

Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

The pull request applies minor textual corrections across various Vim script files, documentation, and test specifications. Typos in error messages, comments, prompts, and test parameters are fixed, and additional logger constants are introduced. These changes do not alter the functional behavior or control flow of the system, serving only to improve clarity and consistency in the codebase and related documents.

Changes

File(s) Change Summary
autoload/fern/fri/from.vim, autoload/fern/internal/buffer.vim, autoload/fern/internal/node.vim, autoload/fern/logger.vim, autoload/fern/scheme/dict/mapping.vim Fixed typos in error messages, comments, and user prompts. Added logger constants in fern/logger.vim without affecting functionality.
doc/fern-develop.txt, doc/fern.txt Corrected typographical errors and improved formatting in documentation, including method signature adjustments.
test/fern/helper.vimspec, test/fern/hook.vimspec Corrected typos in asynchronous test keys and test case descriptions, ensuring parameters are recognized correctly.

Poem

I hopped through the lines with a twitch of my nose,
Fixing typos and quirks wherever they rose.
Every comment and prompt now sings without flaw,
As logger constants join in with a draw.
Hoppy coding, my friend—let clarity be the cause! 🐰✨


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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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 (1)
test/fern/helper.vimspec (1)

264-264: LGTM! Consider extracting timeout options to a helper.

The timeout key correction is good. Since this timeout configuration is used in multiple async tests, consider extracting it to a helper function to ensure consistency and make future maintenance easier.

Example helper function:

function! s:wait_with_timeout(promise) abort
  return Promise.wait(a:promise, { 'timeout': TIMEOUT })
endfunction
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ea72289 and 09291cf.

📒 Files selected for processing (9)
  • autoload/fern/fri/from.vim (1 hunks)
  • autoload/fern/internal/buffer.vim (1 hunks)
  • autoload/fern/internal/node.vim (1 hunks)
  • autoload/fern/logger.vim (1 hunks)
  • autoload/fern/scheme/dict/mapping.vim (1 hunks)
  • doc/fern-develop.txt (5 hunks)
  • doc/fern.txt (8 hunks)
  • test/fern/helper.vimspec (2 hunks)
  • test/fern/hook.vimspec (1 hunks)
✅ Files skipped from review due to trivial changes (8)
  • autoload/fern/internal/node.vim
  • autoload/fern/scheme/dict/mapping.vim
  • autoload/fern/internal/buffer.vim
  • test/fern/hook.vimspec
  • autoload/fern/fri/from.vim
  • doc/fern.txt
  • autoload/fern/logger.vim
  • doc/fern-develop.txt
🔇 Additional comments (1)
test/fern/helper.vimspec (1)

249-249: LGTM! Important fix for test timeout.

The correction of the timeout key is crucial as it ensures proper timeout handling in the asynchronous test. The previous typo could have led to tests hanging indefinitely if there were issues.

@lambdalisue lambdalisue merged commit 60d9a56 into lambdalisue:main Feb 18, 2025
13 checks passed
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