Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

fix: update typo and apply linting #661

Merged
merged 3 commits into from
Dec 21, 2023
Merged

fix: update typo and apply linting #661

merged 3 commits into from
Dec 21, 2023

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Dec 14, 2023

Overview

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Corrected a typographical error in the description of the default store location within the documentation.
    • Clarified error message related to a failed authentication handshake.
    • Made minor formatting changes in the documentation for improved clarity.

Copy link
Contributor

coderabbitai bot commented Dec 14, 2023

Walkthrough

A minor documentation update has been made to the bootstrapper and orchestrator documentation. The changes include correcting a typo in the bootstrapper documentation and making semantic improvements in the orchestrator documentation. These updates are aimed at enhancing the clarity and accuracy of the documentation without impacting the functionality of the codebase.

Changes

File Change Summary
docs/.../bootstrapper.md Corrected a typo from "created un" to "created in".
docs/orchestrator.md Updated note on configuration file location.
Clarified error message for failed authentication.

🐇
In docs so neat and fine,
A tiny typo we did find.
With a hop, a skip, and a quick review,
We fixed the text for me and you. 🌟
🐇

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 X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@codecov-commenter
Copy link

codecov-commenter commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (75b62ec) 24.43% compared to head (eb7f7ba) 24.56%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #661      +/-   ##
==========================================
+ Coverage   24.43%   24.56%   +0.12%     
==========================================
  Files          29       29              
  Lines        3212     3212              
==========================================
+ Hits          785      789       +4     
+ Misses       2331     2328       -3     
+ Partials       96       95       -1     

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

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 75b62ec and ec461eb.
Files selected for processing (1)
  • docs/bootstrapper.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/bootstrapper.md

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ec461eb and 8cf29b5.
Files selected for processing (1)
  • docs/orchestrator.md (2 hunks)

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8cf29b5 and eb7f7ba.
Files selected for processing (1)
  • docs/relayer.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/relayer.md

@jcstein jcstein changed the title fix: update typo fix: update typo and apply linting Dec 14, 2023
@rach-id rach-id merged commit 84ed699 into main Dec 21, 2023
17 of 18 checks passed
@rach-id rach-id deleted the jcstein-patch-1 branch December 21, 2023 19:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants