Skip to content

HELP.md

Latest commit

 

History

History
71 lines (40 loc) · 1.47 KB

HELP.md

File metadata and controls

71 lines (40 loc) · 1.47 KB

Command-Line Help for pep257

This document contains the help content for the pep257 command-line program.

Command Overview:

pep257

A tool to check Rust docstrings against PEP 257 conventions.

Supports multiple comment styles: ///, /** */, and #[doc = "..."].

Examples:

Check current directory

pep257 check

Check a specific file

pep257 check src/main.rs

Check a directory recursively

pep257 check src/

Show warnings in addition to errors

pep257 check --warnings

Output in JSON format

pep257 check --format json

Usage: pep257 [OPTIONS] [COMMAND]

Subcommands:
  • check — Check a file or directory (defaults to current directory)
Options:

  • -v, --verbose — Increase logging verbosity

  • -q, --quiet — Decrease logging verbosity

  • -w, --warnings — Show warnings in addition to errors

  • --format <FORMAT> — Output format

    Default value: text

    Possible values: text, json

  • --no-fail — Exit with code 0 even if violations are found

pep257 check

Check a file or directory (defaults to current directory)

Usage: pep257 check [PATH]

Arguments:
  • <PATH> — Path to check (file or directory, defaults to current directory)

This document was generated automatically by clap-markdown.