docs(rust): API reference master#63
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (39)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
github-actions
Bot
added
area:content
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request migrates the Rust SDK API documentation from high-level crate summaries to a granular, module-based structure across the resq-ai, resq-cli, resq-dsa, and resq-tui crates. Review feedback identifies several issues in the auto-generated content, such as factual inaccuracies in the audit module description, internal implementation details leaking into public signatures, truncated function descriptions, and invalid Rust syntax in generated documentation. The reviewer recommends applying these corrections to the source-level documentation or the generator logic to prevent regressions during future documentation regeneration cycles.
| - [`audit`](#audit) - Blockchain event auditing. | ||
| - [`commit`](#commit) - AI-powered commit message generation. | ||
| - [`completions`](#completions) - Shell-completion emitter (`resq completions <shell>`). | ||
| - [`copyright`](#copyright) - Copyright header management. | ||
| - [`dev`](#dev) - Development server management. | ||
| - [`docs`](#docs) - Documentation management and publication. | ||
| - [`explore`](#explore) - Service exploration and operations. | ||
| - [`format`](#format) - Polyglot source formatting (Rust, TS, Python, C++, C#). | ||
| - [`hook_templates`](#hook_templates) - Canonical git-hook templates embedded for scaffolding and drift detection. | ||
| - [`hooks`](#hooks) - Hooks lifecycle (`resq hooks install/scaffold-local/doctor/update/status`). | ||
| - [`pre_commit`](#pre_commit) - Pre-commit hook logic. | ||
| - [`secrets`](#secrets) - Secret management. | ||
| - [`version`](#version) - Version management and changesets. | ||
|
|
||
| --- | ||
|
|
||
| ## Module: audit | ||
|
|
||
| Blockchain event auditing. | ||
| Blockchain audit command. | ||
|
|
||
| Queries Neo N3 and Solana blockchains for ResQ event records, | ||
| providing audit trails for incident response and delivery verification. |
There was a problem hiding this comment.
The description for the audit module is factually incorrect and redundant. Please update the source-level documentation to correctly identify it as a security/dependency audit tool rather than 'Blockchain event auditing', ensuring the fix persists across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| - `fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>` | ||
| - **Debug** | ||
| - `fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result` |
There was a problem hiding this comment.
Internal implementation details and macro expansion artifacts are leaking into the public documentation (e.g., _serde::__private228::Result). Please apply these fixes to the source-level documentation (e.g., Rust doc comments) or the generator logic instead of this generated file to ensure the fixes persist across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
|
|
||
| **Functions** | ||
|
|
||
| - [`parse_gitignore`](#parse_gitignore) - Parse `.gitignore` from `root` and return a list of simple directory/file |
There was a problem hiding this comment.
The description for the parse_gitignore function is truncated. To ensure this fix persists, please update the source-level documentation (e.g., Rust doc comments) with the full description: 'Parse .gitignore from root and return a list of simple directory/file names to exclude during traversal.'
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| - `fn add<impl AsRef<[u8]>>(self: & mut Self, item: impl Trait)` - Adds an element to the filter. | ||
| - `fn has<impl AsRef<[u8]>>(self: &Self, item: impl Trait) -> bool` - Checks if an element might be in the set. |
There was a problem hiding this comment.
The generated function signatures for add and has contain invalid Rust syntax (<impl AsRef<[u8]>>) and generic placeholders. Please update the generator logic or source-level documentation to correctly handle impl Trait in argument positions, ensuring the fix persists across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g. XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
|
Closing — first cargo-doc-md run hit a [lib].name oversight + bare-link issue. Re-triggering with PR #64 applied. |
2 participants
Auto-generated by
API docs (Rust)inresq-software/cratesfor refmaster(run: 25624299249).
Regenerated stub pages under
sdks/rust/api/. Each pageembeds the crate's README and links to docs.rs for the
canonical API reference.