Apply review style fix

[leynos]

Summary

• update LengthFormat and LengthPrefixedProcessor docs to keep attributes after comments

Testing

• make fmt
• make lint
• make test
• mdformat-all
• markdownlint --fix
• nixie docs/*

---

https://chatgpt.com/codex/tasks/task_e_685575b46e908322b312e27581b4e6df

Summary by Sourcery

Refine documentation comments for LengthFormat and LengthPrefixedProcessor to preserve attributes post-comments and improve clarity.

Documentation:

• Reformat and expand doc comments on LengthFormat constructors, read_len, write_len, and Default impl with parameter, return, and error sections
• Refine doc comments on LengthPrefixedProcessor new() and default() methods to maintain attribute placement and add structured sections

[sourcery-ai]

Reviewer's Guide

This PR refactors documentation in src/frame.rs for both LengthFormat and LengthPrefixedProcessor, standardizing comment layout, expanding parameter/return/error sections, reflowing text, and relocating #[must_use] attributes immediately after their doc comments.

Class diagram for LengthFormat and LengthPrefixedProcessor (no structural changes, doc refactor only)

classDiagram
    class LengthFormat {
        +usize bytes
        +Endianness endianness
        +const fn new(bytes: usize, endianness: Endianness) -> Self
        +const fn u16_be() -> Self
        +const fn u16_le() -> Self
        +const fn u32_be() -> Self
        +const fn u32_le() -> Self
        +fn read_len(&self, bytes: &[u8]) -> io::Result<usize>
        +fn write_len(&self, len: usize, dst: &mut BytesMut) -> io::Result<()> 
        +fn default() -> Self
    }
    class LengthPrefixedProcessor {
        +LengthFormat format
        +const fn new(format: LengthFormat) -> Self
        +fn default() -> Self
    }
    LengthPrefixedProcessor --> LengthFormat : uses

Loading

File-Level Changes

Change	Details	Files
Standardized and enriched documentation for length-framing utilities	Expanded doc comments with explicit # Parameters, # Returns, and # Errors sections Reflowed long comment lines to consistent width Updated comments on constructors (new, u16_be, u16_le, u32_be, u32_le), read_len, write_len, and Default impls	src/frame.rs
Repositioned #[must_use] attributes to immediately follow doc comments	Moved #[must_use] above each function signature after its doc block for LengthFormat Moved #[must_use] above each function signature after its doc block for LengthPrefixedProcessor	src/frame.rs

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/action-unresolved-comments-on-pull-request

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this 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.