rewrite-rustdoc

Rewrite Rust documentation comments to English and enforce rustdoc guidelines.

21|Updated May 23, 2025
One-click install
npx skills add https://github.com/jim60105/copilot-prompt --skill rewrite-rustdoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rewrite-rustdoc
Source: https://github.com/jim60105/copilot-prompt/tree/main/skills/rewrite-rustdoc
Command: npx skills add https://github.com/jim60105/copilot-prompt --skill rewrite-rustdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all Rust documentation comments and code comments are in English, adhering to rustdoc guidelines, and fixing any missing documentation.

Core Features & Use Cases

  • Language Enforcement: Translates or corrects non-English comments to English.
  • Documentation Completeness: Identifies and helps fix missing documentation.
  • Rustdoc Compliance: Ensures adherence to official rustdoc standards.
  • Use Case: You have a Rust project with some comments and documentation in Chinese. This Skill will help you convert them to English and ensure all necessary documentation is present.

Quick Start

Use the rewrite-rustdoc skill to ensure all documentation comments in the src directory are in English.

Frequently Asked Questions about rewrite-rustdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I convert Chinese comments in Rust source code to English?

Converting Chinese comments involves rewriting non-English documentation to adhere to rustdoc guidelines. This process identifies Chinese characters using `rg` and translates them to ensure English-only Rust source files.

How do I check for missing documentation in a Rust project?

Checking for missing documentation in a Rust project requires running `cargo clippy` to identify undocumented code blocks. This enforces rustdoc compliance and helps generate missing doc comments for your source files.

What is the best way to ensure Rust documentation follows rustdoc guidelines?

The best way to ensure Rust documentation follows rustdoc guidelines is by rewriting comments to enforce English-only content and checking for missing docs. Using `cargo clippy` validates that all necessary documentation is present and compliant.

Does this Rust documentation translation process require any specific tools?

Yes, this Rust documentation translation process requires `rg` for searching non-English characters and `cargo clippy` for checking missing documentation. These tools identify translation needs and enforce rustdoc compliance within the project.

How do I fix rustdoc compliance issues for non-English comments?

Fixing rustdoc compliance issues for non-English comments involves rewriting the identified text to enforce English-only content. The process addresses both non-English comments and missing documentation to meet official rustdoc standards.