Skip to content

🔧 use forked clap-markdown#2393

Merged
ChanTsune merged 1 commit into
mainfrom
docs/clap-markdown/use-fork
Nov 30, 2025
Merged

🔧 use forked clap-markdown#2393
ChanTsune merged 1 commit into
mainfrom
docs/clap-markdown/use-fork

Conversation

@ChanTsune
Copy link
Copy Markdown
Owner

No description provided.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @ChanTsune, 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 refactors the documentation generation process by switching to a custom-forked version of the clap-markdown library. This change eliminates the need for local patches and complex string manipulations that were previously required to produce correct markdown output, leading to a cleaner and more maintainable codebase for the xtask utility.

Highlights

  • Dependency Update: The clap-markdown dependency has been updated to use a forked version from a specific Git repository and branch (ChanTsune/clap-markdown.git, issue/54).
  • Code Simplification: Several custom workarounds and helper functions (clear_display_names, fix_duplicate_command_paths) previously used to correct issues with clap-markdown's output have been removed, as the forked version likely addresses these problems directly.
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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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.

Copy link
Copy Markdown
Contributor

@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 switches the clap-markdown dependency to a forked version, which seems to include fixes for bugs that were previously worked around in the codebase. This has allowed for the removal of a significant amount of complex workaround code, greatly simplifying the docgen task. This is an excellent improvement.

I've added a couple of suggestions:

  • In xtask/Cargo.toml, I recommend pinning the git dependency to a specific commit hash instead of a branch name to ensure reproducible builds.
  • In xtask/src/main.rs, I've suggested a small reordering in the docgen function to fail faster if the output directory cannot be created.

Comment thread xtask/Cargo.toml
Comment thread xtask/src/main.rs
@github-actions github-actions Bot added the dependencies Pull requests that update a dependency file label Nov 29, 2025
@ChanTsune ChanTsune merged commit b796fba into main Nov 30, 2025
98 of 99 checks passed
@ChanTsune ChanTsune deleted the docs/clap-markdown/use-fork branch November 30, 2025 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant