Fix comments

[kaidokert]

Summary by Sourcery

Correct comments in DirectBuffer tests to accurately describe the escape_reserve calculation.

Chores:

• Update test comments to state 12.5% of buffer length instead of 10% for escape_reserve.
• Replace division by 10 notation with a right-shift operation description (>>3) in test comments.

Summary by CodeRabbit

• Documentation
  • Updated comments in test assertions to accurately describe the calculation of buffer reserve values. No changes to functionality or test logic.

[sourcery-ai]

Reviewer's Guide

This PR updates inline comments in DirectBuffer tests to accurately describe the escape_reserve calculation (12.5% via right shift) without altering any functionality.

File-Level Changes

Change	Details	Files
Corrected test comments to reflect actual escape_reserve calculation	Updated comment from “10% of 100” to “12.5% of 100” Replaced “max(100/10, 64)” with “max(100>>3, 64)” Unified escape_reserve percentage description in a third test comment	picojson/src/direct_buffer.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]

Walkthrough

This change updates comments in test assertions for the DirectBuffer struct to accurately describe the calculation of the escape_reserve field as 12.5% of the buffer length (with a minimum of 64 bytes), instead of the previously stated 10%. No functional or logic changes were made.

Changes

File(s)	Change Summary
picojson/src/direct_buffer.rs	Corrected comments in test assertions to clarify escape_reserve calculation as 12.5% (right shift by 3) of buffer length, minimum 64 bytes; no code logic changes.

Possibly related PRs

• kaidokert/picojson-rs#29: Updates the actual escape_reserve calculation from 10% to 12.5% and modifies tests, whereas this PR only corrects the comments to match the existing logic.

Poem

🐇
With comments now clear as a bell,
Escape reserves we truthfully tell.
Twelve-point-five percent, not ten,
The buffer math is right again!
No code was changed, just words made bright—
Now all our docs read just right.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Clippy (1.86.0)

Updating crates.io index

warning: failed to write cache, path: /usr/local/registry/index/index.crates.io-1949cf8c6b5b557f/.cache/de/fm/defmt, error: Permission denied (os error 13)
Locking 68 packages to latest compatible versions
Downloading crates ...
Downloaded log v0.4.27
error: failed to create directory /usr/local/registry/cache/index.crates.io-1949cf8c6b5b557f

Caused by:
Permission denied (os error 13)

---

📜 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 0e071c9 and b1dcb41.

📒 Files selected for processing (1)

• picojson/src/direct_buffer.rs (3 hunks)

🧰 Additional context used

🧠 Learnings (1)

picojson/src/direct_buffer.rs (1)

Learnt from: kaidokert
PR: kaidokert/picojson-rs#5
File: picojson/src/lib.rs:0-0
Timestamp: 2025-06-29T17:48:18.188Z
Learning: In the picojson-rs project, the `use tokenizer as ujson;` alias in lib.rs is a transitionary and fully internal private alias used during crate reorganization. Examples and external code no longer depend on this alias, making the private visibility appropriate.

⏰ Context from checks skipped due to timeout of 90000ms (21)

• GitHub Check: coverage
• GitHub Check: AVR Panic Prevention (int32, pico-huge, dev)
• GitHub Check: AVR Panic Prevention (int32, pico-huge, release)
• GitHub Check: AVR Panic Prevention (int32, pico-tiny, dev)
• GitHub Check: Build (thumbv6m-none-eabi)
• GitHub Check: AVR Panic Prevention (int8, pico-tiny, dev)
• GitHub Check: Build (thumbv7m-none-eabi)
• GitHub Check: AVR Panic Prevention (int32, pico-tiny, release)
• GitHub Check: AVR Panic Prevention (int8, pico-tiny, release)
• GitHub Check: AVR Panic Prevention (int8, pico-huge, dev)
• GitHub Check: AVR Panic Prevention (int8, pico-huge, release)
• GitHub Check: Run AVR Test Suites
• GitHub Check: AVR Panic Prevention (int32, pico-tiny, dev)
• GitHub Check: AVR Panic Prevention (int8, pico-huge, dev)
• GitHub Check: AVR Panic Prevention (int32, pico-huge, release)
• GitHub Check: AVR Panic Prevention (int32, pico-tiny, release)
• GitHub Check: AVR Panic Prevention (int32, pico-huge, dev)
• GitHub Check: AVR Panic Prevention (int8, pico-tiny, dev)
• GitHub Check: AVR Panic Prevention (int8, pico-tiny, release)
• GitHub Check: AVR Panic Prevention (int8, pico-huge, release)
• GitHub Check: Run AVR Test Suites

🔇 Additional comments (3)

picojson/src/direct_buffer.rs (3)

228-228: LGTM! Comment accurately reflects the calculation.

The comment correctly states that for a 100-byte buffer, the escape reserve is 12.5% with a minimum of 64 bytes, resulting in 64 bytes reserved.

---

342-342: LGTM! Mathematical calculation is correct.

The comment accurately shows the calculation: max(100>>3, 64) = 64 where 100>>3 = 12 and max(12, 64) = 64.

---

418-418: LGTM! Clear explanation of the escape reserve calculation.

The comment correctly explains that the escape reserve is set to 12.5% of the buffer length (100 bytes) with a minimum of 64 bytes.

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

[gemini-code-assist]

Summary of Changes

Hello @kaidokert, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving code clarity and accuracy by updating outdated comments within the direct_buffer.rs file. The changes ensure that the explanations for the escape_reserve calculation in various test assertions correctly reflect the underlying logic, enhancing readability for future maintainers.

Highlights

• Comment Correction: Updated comments in picojson/src/direct_buffer.rs to accurately reflect the calculation logic for escape_reserve. Specifically, comments were changed to reflect 12.5% instead of 10% and 100>>3 instead of 100/10 in test assertions.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[sourcery-ai]

Hey @kaidokert - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[gemini-code-assist]

Code Review

This pull request correctly updates comments related to the escape_reserve calculation to reflect the use of a bit-shift (>> 3) which corresponds to ~12.5% of the buffer length, instead of the previously stated 10%. The changes improve the accuracy of the test comments. I've added a couple of suggestions to further improve consistency and clarity in the comments across the test suite.