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 markdown link path #252

Merged
merged 1 commit into from
Aug 2, 2024
Merged

📝 fix markdown link path #252

merged 1 commit into from
Aug 2, 2024

Conversation

Milly
Copy link
Contributor

@Milly Milly commented Aug 2, 2024

Summary by CodeRabbit

  • Documentation
    • Updated file paths in the README documentation to ensure correct references to script locations for developers.
    • Maintained overall content and intent regarding the automatic code generation for Vim and Neovim.

Copy link

coderabbitai bot commented Aug 2, 2024

Walkthrough

The recent changes involve minor adjustments to the file paths in the README documentation for the function and option scripts. The paths to gen-function.ts and gen-option.ts have been updated for accuracy, ensuring documentation clarity without affecting the underlying functionality of the code.

Changes

Files Change Summary
function/README.md, option/README.md Corrected paths for gen-function.ts and gen-option.ts from ../../scripts/... to ../.scripts/...; no functional changes made.

Poem

In the burrow, paths align,
Scripts now shine with paths divine.
Hopping through, our work refined,
Little changes, great joy combined!
🐰✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 38ddb1f and 9ce7861.

Files selected for processing (2)
  • function/README.md (1 hunks)
  • option/README.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • function/README.md
  • option/README.md

Copy link

codecov bot commented Aug 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.27%. Comparing base (f3be1cd) to head (85fce95).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #252   +/-   ##
=======================================
  Coverage   82.27%   82.27%           
=======================================
  Files          57       57           
  Lines        2973     2973           
  Branches      251      251           
=======================================
  Hits         2446     2446           
  Misses        525      525           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9ce7861 and 9565a77.

Files selected for processing (2)
  • function/README.md (1 hunks)
  • option/README.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • function/README.md
  • option/README.md

@Milly Milly requested a review from lambdalisue August 2, 2024 17:54
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9565a77 and 85fce95.

Files selected for processing (2)
  • function/README.md (1 hunks)
  • option/README.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • function/README.md
  • option/README.md

@lambdalisue lambdalisue merged commit a0c13e7 into main Aug 2, 2024
10 checks passed
@lambdalisue lambdalisue deleted the doc branch August 2, 2024 18:11
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