chore: fix some function names in comment

[threehonor]

Proposed changes

fix some function names in comment

Checklist

• Pull request is created against the dev branch
• All checks passed (lint, unit/integration/regression tests etc.) with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Summary by CodeRabbit

• Documentation
  • Updated internal descriptive texts for HTTP header conversion.
  • Refined messaging around data serialization and request handling.
  • These improvements enhance clarity and consistency in internal documentation without affecting any user-facing functionality.

[coderabbitai]

Walkthrough

This pull request updates documentation comments in two source files. In pkg/protocols/utils/utils.go, the comment for the HeadersToString function is modified to use proper capitalization. In pkg/templates/templates.go, the YAML function comment is corrected—from MarshalYAML to UnmarshalYAML—and a function comment is updated to reflect the renaming from addProtocolsToQueue to addRequestsToQueue. There are no changes to functionality or logic.

Changes

File(s)	Change Summary
pkg/protocols/utils/utils.go	Updated comment for HeadersToString: changed from headersToString converts http headers to string to HeadersToString converts http headers to string.
pkg/templates/templates.go	Corrected YAML function comment: changed from MarshalYAML forces recursive struct validation after unmarshal operation to UnmarshalYAML forces recursive struct validation after unmarshal operation; and updated the comment to rename addProtocolsToQueue to addRequestsToQueue.

Suggested reviewers

• ehsandeep
• dogancanbakir

Poem

Oh, what a hop in the code-filled glen,
With comments bright as a morning pen.
I nibbled through text, so swift and keen,
Changing names to fit the scene.
With floppy ears, I celebrate this sprint! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b833bc9 and d1b1c23.

📒 Files selected for processing (2)

• pkg/protocols/utils/utils.go (1 hunks)
• pkg/templates/templates.go (2 hunks)

🔇 Additional comments (3)

pkg/protocols/utils/utils.go (1)

51-71: Improved Documentation for HeadersToString
The comment has been updated to use the correct capitalization ("HeadersToString"), which now matches the function name. This clarification helps maintain consistency between the documentation and the code.

pkg/templates/templates.go (2)

320-320: Corrected Comment for UnmarshalYAML
The comment now accurately describes the function’s behavior by stating that it forces recursive struct validation after unmarshalling. This change ensures the documentation reflects the true functionality of the method.

---

478-478: Updated Function Comment for addRequestsToQueue
The comment has been revised to correctly reference the updated function name (addRequestsToQueue) instead of the old name (addProtocolsToQueue). This update improves clarity and consistency in the code documentation.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.