Skip to content

docs(rust): API reference master#80

Merged
WomB0ComB0 merged 1 commit into
mainfrom
auto/rust-api-master
May 15, 2026
Merged

docs(rust): API reference master#80
WomB0ComB0 merged 1 commit into
mainfrom
auto/rust-api-master

Conversation

@WomB0ComB0
Copy link
Copy Markdown
Member

Auto-generated by API docs (Rust) in
resq-software/crates for ref master
(run: 25922573628).

Regenerated stub pages under sdks/rust/api/. Each page
embeds the crate's README and links to docs.rs for the
canonical API reference.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

Warning

Rate limit exceeded

@WomB0ComB0 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 18 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 84b12951-0f13-4a55-acfa-c71e24357512

📥 Commits

Reviewing files that changed from the base of the PR and between 547e008 and 29ea9ba.

📒 Files selected for processing (2)
  • docs.json
  • sdks/rust/api/resq-bin/index.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch auto/rust-api-master

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc. labels May 15, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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
  1. When maintaining lists in auto-generated documentation, ensure the generator logic enforces consistent ordering to match source-of-truth configuration files like _pages.json.
  2. 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.

@WomB0ComB0 WomB0ComB0 merged commit 21bc5dc into main May 15, 2026
14 checks passed
@WomB0ComB0 WomB0ComB0 deleted the auto/rust-api-master branch May 15, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc. automated docs:api-ref language:rust

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants