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.

Sign up for GitHub

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

Jump to bottom

docs: fix typos in release notes #4192

Closed
wants to merge 1 commit into from
Closed

docs: fix typos in release notes #4192

wants to merge 1 commit into from

Conversation

tiendn
Copy link
Contributor

@tiendn tiendn commented Jan 7, 2025

Corrected capitalization and spelling errors in the release notes documentation:

  • Changed "command on the host machine." to "Command on the host machine."
  • Updated "tally of signalling" to "tally of signaling."

These changes enhance readability and maintain consistency in terminology.

@tiendn
docs: fix typos in release notes
aa390bd 
Corrected capitalization and spelling errors in the release notes documentation:
- Changed "command on the host machine." to "Command on the host machine."
- Updated "tally of signalling" to "tally of signaling."

These changes enhance readability and maintain consistency in terminology.
@tiendn tiendn requested a review from a team as a code owner January 7, 2025 13:24
@tiendn tiendn requested review from cmwaters and rach-id and removed request for a team January 7, 2025 13:24
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 7, 2025 •
edited
Loading

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 52 minutes and 28 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e4c9f2d and aa390bd.

📒 Files selected for processing (1)
  • docs/release-notes/release-notes.md (2 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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

rootulp
rootulp requested changes Jan 7, 2025
View reviewed changes
docs/release-notes/release-notes.md
@@ -15,7 +15,7 @@ if using linux in docker, kubernetes, a vm or baremetal, this can be done by cal
make enable-bbr
```

command on the host machine.
Command on the host machine.
Copy link
Collaborator

Choose a reason for hiding this comment

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

seems fine to leave uncapitalized b/c I think it's a continuation of "this can be done by calling ___ command on the host machine"

Suggested change
Command on the host machine.
command on the host machine.

docs/release-notes/release-notes.md
@@ -48,7 +48,7 @@ The following command can be used, if you are a validator in the active set, to
celestia-appd tx signal signal 3 <plus transaction flags>
```

You can track the tally of signalling by validators using the following query
You can track the tally of signaling by validators using the following query
Copy link
Collaborator

Choose a reason for hiding this comment

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

Apparently both are fine https://sapling.ai/usage/signaling-vs-signalling#:~:text=Signaling%20and%20signalling%20are%20both,)%20(%20en%2DGB%20).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay

@rootulp rootulp closed this Jan 7, 2025
@rootulp
Copy link
Collaborator

rootulp commented Jan 7, 2025

The fixes in this PR aren't necessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rootulp rootulp rootulp requested changes

@cmwaters cmwaters Awaiting requested review from cmwaters cmwaters is a code owner automatically assigned from celestiaorg/celestia-core

@rach-id rach-id Awaiting requested review from rach-id rach-id is a code owner automatically assigned from celestiaorg/celestia-core

@evan-forbes evan-forbes Awaiting requested review from evan-forbes

@ninabarbakadze ninabarbakadze Awaiting requested review from ninabarbakadze

Assignees
No one assigned
Labels
external
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tiendn @rootulp