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

📚 Doc: typo in hooks documentation #3164

Merged
merged 1 commit into from
Oct 12, 2024

Conversation

SantiagoBobrik
Copy link
Contributor

@SantiagoBobrik SantiagoBobrik commented Oct 12, 2024

Description

This PR fixes a typo in the hooks documentation.

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

  • Documentation Update: Corrected a typo in the hook documentation file.

Type of change

Please delete options that are not relevant.

  • Documentation update (changes to documentation)

Checklist

  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.

@SantiagoBobrik SantiagoBobrik requested a review from a team as a code owner October 12, 2024 02:04
@SantiagoBobrik SantiagoBobrik requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team October 12, 2024 02:04
Copy link

welcome bot commented Oct 12, 2024

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Oct 12, 2024

Walkthrough

The changes in this pull request involve updates to the documentation for hooks in Fiber, specifically correcting typographical errors such as "registeration" to "registration." These corrections were made in both the documentation file hooks.md and the comments in the hooks.go file. The structure and content of the documentation remain unchanged, with no modifications to the hooks' functionality or their signatures.

Changes

File(s) Change Summary
docs/api/hooks.md Corrected "registeration" to "registration" in descriptions.
hooks.go Corrected "registeration" to "registration" in comments.

Possibly related PRs

Suggested labels

v3

Suggested reviewers

  • sixcolors
  • ReneWerner87
  • gaby
  • efectn

Poem

In the land of Fiber, where hooks do play,
A typo was hiding, but now it's away.
"Registration" shines bright, clear as can be,
With docs all corrected, it's happy and free!
Hops of delight, in code we rejoice,
For clarity reigns, let’s all raise our voice! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 079d301 and 72e97c5.

📒 Files selected for processing (2)
  • docs/api/hooks.md (2 hunks)
  • hooks.go (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • hooks.go
🧰 Additional context used
🪛 LanguageTool
docs/api/hooks.md

[uncategorized] ~37-~37: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...r functions on each route registration. Also you can get route properties by **route...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)


[uncategorized] ~107-~107: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...r functions on each group registration. Also you can get group properties by **group...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)


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 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
Member

@gaby gaby left a comment

Choose a reason for hiding this comment

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

👍 LGTM

@gaby gaby added the v3 label Oct 12, 2024
Copy link

codecov bot commented Oct 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.48%. Comparing base (079d301) to head (72e97c5).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3164   +/-   ##
=======================================
  Coverage   82.48%   82.48%           
=======================================
  Files         113      113           
  Lines        8466     8466           
=======================================
  Hits         6983     6983           
  Misses       1083     1083           
  Partials      400      400           
Flag Coverage Δ
unittests 82.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@gaby gaby merged commit 48e82e7 into gofiber:main Oct 12, 2024
18 of 19 checks passed
Copy link

welcome bot commented Oct 12, 2024

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

@gaby
Copy link
Member

gaby commented Oct 12, 2024

@SantiagoBobrik Thank you, really appreciate it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants