chore: minor tidy ups

[pmcgleenon]

README tidyup & removed unused dependency from Cargo

Summary by CodeRabbit

• Documentation
  • Updated licensing details to reflect dual MIT/Apache 2.0 terms.
  • Added a new link for quick access to the project documentation.

[coderabbitai]

Walkthrough

This pull request updates the Rust package configuration and documentation. In Cargo.toml, it activates debug information for release builds and removes the zipf development dependency. The README.md is modified to display a dual MIT/Apache 2.0 license badge with updated URLs and includes a new documentation link. Additionally, the benchmarks file simplifies its imports by removing an unnecessary import.

Changes

File(s)	Change Summary
Cargo.toml	Enabled debug info in [profile.release] by changing #debug = true to debug = true, and removed the zipf = "7.0.1" entry from [dev-dependencies].
README.md	Replaced the MIT license badge with a dual MIT/Apache 2.0 badge, updated the badge and license URLs, and added a new documentation link labeled "📖 Docs".
benches/topk_add.rs	Removed the unused Distribution import from rand::distr, retaining only the StandardUniform import.

Possibly related PRs

• chore: added badges for crate, license, github status #20: Involves similar modifications to the README regarding license badge updates and documentation links.

---

📜 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 7d4c108 and 0bec5c1.

📒 Files selected for processing (3)

• Cargo.toml (1 hunks)
• README.md (1 hunks)
• benches/topk_add.rs (1 hunks)

🔇 Additional comments (5)

benches/topk_add.rs (1)

3-3: LGTM! Import cleanup looks good.

The removal of the unused Distribution trait import is a good cleanup, as the trait is automatically imported when using StandardUniform.

Cargo.toml (2)

34-36: LGTM! Dependency cleanup looks good.

The removal of the unused zipf dependency from dev-dependencies aligns with the PR objectives.

---

32-32:

❓ Verification inconclusive

Verify the impact of enabling debug info in release builds.

Enabling debug info in release builds will increase binary size but can be helpful for debugging production issues.

Run this script to check the impact on binary size:

---

🏁 Script executed:

#!/bin/bash
# Description: Compare binary sizes with and without debug info

# Build with debug info
cargo clean
cargo build --release
ls -lh target/release/heavykeeper

# Build without debug info (temporary change)
sed -i.bak 's/debug = true/#debug = true/' Cargo.toml
cargo clean
cargo build --release
ls -lh target/release/heavykeeper

# Restore original
mv Cargo.toml.bak Cargo.toml

Length of output: 768

---

Action Required: Manually Verify Binary Size Impact of Debug Info in Release Builds

The verification script did not yield any useful output since the Rust toolchain (cargo) was not found. Please run this check in an environment with Rust/cargo installed or manually confirm that the increase in binary size from enabling debug info (set via debug = true in Cargo.toml at line 32) is acceptable for production debugging purposes.

• Verify that the Rust toolchain is available before running the build comparison.
• Manually compare the binary sizes of the release build with and without debug info to ensure the trade-off is reasonable.
• Confirm that keeping debug info enabled in release builds aligns with the intended maintenance and debugging strategy.

README.md (2)

4-4: LGTM! License badge update looks good.

The license badge and URL updates accurately reflect the dual MIT/Apache 2.0 license mentioned in the License section.

Also applies to: 9-10

---

14-16: LGTM! Documentation link is a good addition.

Adding a link to docs.rs documentation improves accessibility for users.

---

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

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

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.