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

Fixing Typographical Errors in Documentation #23209

Closed
wants to merge 4 commits into from

Conversation

JohnBonny
Copy link

@JohnBonny JohnBonny commented Jan 6, 2025

changed made:

If not address - If no address

fmt'ing - formatting

obkect - object

LegacyAmingPubKey - LegacyAminoPubKey

Summary by CodeRabbit

  • Documentation
    • Fixed grammatical and spelling errors in comments across multiple files:
      • Corrected comment in GetAddressCodec method
      • Updated log message in pre-commit hook script
      • Fixed typo in secp256k1_ec_pubkey_tweak_mul function documentation
      • Corrected terminology in AddSignature function comment

Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request consists of minor textual corrections across multiple files, focusing on improving documentation clarity and fixing typographical errors. The changes span different components of the codebase, including a pre-commit hook script, codec utility, cryptographic library header, and a multisignature implementation. These modifications do not alter any functional code but enhance the readability and accuracy of comments and documentation.

Changes

File Change Summary
codec/testutil/codec.go Corrected comment grammar from "If not address codec was provided" to "If no address codec was provided"
contrib/githooks/pre-commit Updated log message from "[pre-commit] fmt'ing staged files..." to "[pre-commit] formatting staged files..."
crypto/keys/secp256k1/internal/secp256k1/libsecp256k1/include/secp256k1.h Fixed typo in documentation comment from "public key obkect" to "public key object"
crypto/types/multisig/multisignature.go Corrected comment term from "LegacyAmingPubKey" to "LegacyAminoPubKey"

Possibly related PRs

Suggested labels

C:CLI, C:Store

Suggested reviewers

  • sontrinh16
  • kocubinski
  • testinginprod
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f2bab5 and e2ae5f0.

📒 Files selected for processing (4)
  • codec/testutil/codec.go (1 hunks)
  • contrib/githooks/pre-commit (1 hunks)
  • crypto/keys/secp256k1/internal/secp256k1/libsecp256k1/include/secp256k1.h (1 hunks)
  • crypto/types/multisig/multisignature.go (1 hunks)

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.

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.

@julienrbrt
Copy link
Member

Hey, we do not accept typo fixing PRs only, this is according to our CONTRIBUTING.

@julienrbrt julienrbrt closed this Jan 6, 2025
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