docs-guidelines

Étoiles29

Forks3

Mis à jour11 mars 2026 à 12:11

Guidelines for writing Rust documentation. Refer to this when you need to write doc comments on functions, types or modules.

Installation

Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.

Exécuter dans Manus

Source

LukeMathWalker

LukeMathWalker/cheadergen

Ouvrir le dépôt GitHub Voir les dépôts du créateur

Téléchargement

Exécuter dans Manus

Métiers associésSOC

Basé sur la classification professionnelle SOC

Développeurs de logicielsProfessions informatiques et mathématiques·SOC 15-1252

SKILL.md

readonly

name	docs-guidelines
description	Guidelines for writing Rust documentation. Refer to this when you need to write doc comments on functions, types or modules.

Docs Guidelines

Standards to follow when writing code-level documentation.

Guidelines

Key concepts should be explained only once. All other documentation should use an intra-documentation link to the first explanation.
Always use an intra-documentation link when mentioning a Rust symbol (type, function, constant, etc.).
Avoid referring to specific lines or line ranges, as they may change over time. Use line comments if the documentation needs to be attached to a specific code section inside a function/method body.
Focus on why, not how. In particular, avoid explaining trivial implementation details in line comments.
Refer to constants using intra-documentation links. Don't hard-code their values in the documentation of other items.
Intra-documentation links to private items are allowed. Don't duplicate.

Plus depuis ce dépôt

même dépôt

ui-tests

LukeMathWalker/cheadergen

Reference for the ui-tests infrastructure: test suites, directory layout, test.toml format, snapshot workflow, and common commands. Use when working with ui-tests cases, debugging test failures, or scaffolding new tests.

2026-04-0329

verify

LukeMathWalker/cheadergen

Runs the cheadergen verification workflow in stages - lint, format, generation tests, and full test suite. Use when user says "verify", "run checks", "run tests", or wants to validate changes before committing.

2026-03-2729

rustdoc

LukeMathWalker/cheadergen

Look up Rust dependency API docs locally. Use when the user or task requires information about a dependency's API, types, traits, functions, or modules — e.g. "look up guppy's PackageGraph", "what methods does rustdoc_types::Item have", "show me clap's derive API".

2026-03-1029

write-test

LukeMathWalker/cheadergen

Write a test to improve code coverage. Uses `cargo llvm-cov` to identify uncovered lines, then writes a focused test to cover them. Use when user says "write test", "improve coverage", "cover lines", or "write-test".

2026-03-0729

name	docs-guidelines
description	Guidelines for writing Rust documentation. Refer to this when you need to write doc comments on functions, types or modules.

Docs Guidelines

Standards to follow when writing code-level documentation.

Guidelines

Key concepts should be explained only once. All other documentation should use an intra-documentation link to the first explanation.
Always use an intra-documentation link when mentioning a Rust symbol (type, function, constant, etc.).
Avoid referring to specific lines or line ranges, as they may change over time. Use line comments if the documentation needs to be attached to a specific code section inside a function/method body.
Focus on why, not how. In particular, avoid explaining trivial implementation details in line comments.
Refer to constants using intra-documentation links. Don't hard-code their values in the documentation of other items.
Intra-documentation links to private items are allowed. Don't duplicate.