docs(rust): API reference master#80
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 (2)
✨ 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 |
There was a problem hiding this comment.
Code Review
This pull request removes the bin_explorer module link from the Rust API documentation index. Feedback indicates that this change introduces inconsistencies with source-of-truth configuration files like docs.json and _pages.json. It is recommended to apply such changes to the source-level documentation or configuration files directly to prevent them from being overwritten during regeneration cycles.
| Click through to each module for the full rustdoc-rendered API surface (types, traits, functions, methods). | ||
|
|
||
| - [`analysis`](./analysis) | ||
| - [`bin_explorer`](./bin_explorer) |
There was a problem hiding this comment.
The removal of the bin_explorer module link here creates an inconsistency with docs.json (line 2169) and sdks/rust/api/_pages.json (line 7). Per repository rules, documentation lists must remain consistent with source-of-truth configuration files. Furthermore, ensure these changes are applied to the source-level documentation (e.g., XML doc comments) or the configuration files themselves, rather than manually editing generated files, to ensure the changes persist across regeneration cycles.
References
- When maintaining lists in auto-generated documentation, ensure the generator logic enforces consistent ordering to match source-of-truth configuration files like _pages.json.
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation instead of the generated files to ensure the fixes persist across regeneration cycles.
Auto-generated by
API docs (Rust)inresq-software/cratesfor refmaster(run: 25922573628).
Regenerated stub pages under
sdks/rust/api/. Each pageembeds the crate's README and links to docs.rs for the
canonical API reference.