Skip to content

xtask: keep docs-sync generated blocks untouched#298

Merged
EffortlessSteven merged 1 commit into
mainfrom
chore/main-xtask-pr
Mar 25, 2026
Merged

xtask: keep docs-sync generated blocks untouched#298
EffortlessSteven merged 1 commit into
mainfrom
chore/main-xtask-pr

Conversation

@EffortlessSteven

@EffortlessSteven EffortlessSteven commented Mar 25, 2026

Copy link
Copy Markdown
Member

Summary

  • Update xtask docs-sync logic to preserve manually maintained README prose and avoid mutating generated doc blocks.
  • Keep generated feature/workspace/example sections unchanged while maintaining docs-sync validation.

Validation

  • cargo xtask lint-fix --check
  • cargo xtask docs-sync --check

@coderabbitai

coderabbitai Bot commented Mar 25, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

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

⌛ 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ebfddaa9-68f7-4400-aacd-d1802f55b1b7

📥 Commits

Reviewing files that changed from the base of the PR and between d3ced09 and 56c333b.

📒 Files selected for processing (2)
  • xtask/src/docs_sync.rs
  • xtask/src/main.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/main-xtask-pr

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.

@gemini-code-assist

gemini-code-assist Bot commented Mar 25, 2026

Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 refines the xtask documentation synchronization logic to prevent unintended modifications of manually maintained content within README.md. The changes primarily involve reformatting existing code for better readability and maintainability, ensuring that the docs-sync tool precisely targets and updates only its generated sections, thereby preserving the integrity of other document parts.

Highlights

  • Documentation Synchronization Logic: The xtask docs-sync tool's logic has been updated to ensure it precisely targets and replaces only its designated generated blocks within README.md, effectively preserving any manually maintained prose.
  • Code Readability Improvements: Various macro calls, including bail!, writeln!, and cmd.args, have been reformatted to use multiline arguments, enhancing code readability and maintainability.
  • Minor Refactoring: A replace_block function call was refactored for conciseness, and module declarations in main.rs were reordered, both without functional changes.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

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. ↩

gemini-code-assist[bot]
gemini-code-assist Bot reviewed Mar 25, 2026
View reviewed changes

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

Copy link
Copy Markdown

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 primarily focuses on code formatting and minor structural adjustments within the xtask crate. Specifically, it refactors several writeln!, bail!, and cmd.args! macro calls in xtask/src/docs_sync.rs to improve readability by introducing line breaks. It also adds braces to a conditional statement in the checkmark function and reorders the docs_sync module declaration in xtask/src/main.rs. There are no review comments to address.

@EffortlessSteven EffortlessSteven merged commit f06a9ca into main Mar 25, 2026
4 checks passed
@EffortlessSteven EffortlessSteven deleted the chore/main-xtask-pr branch April 3, 2026 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@EffortlessSteven