CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/pypi-pep257

Python docstring style checker for PEP 257 compliance

72

1.04x
Overview
Eval results
Files

rubric.jsonevals/scenario-5/

{
  "context": "Evaluates how the CLI wires decorator- and property-aware docstring linting through pydocstyle. Checks focus on forwarding decorator regex filters, property decorator handling, the self-only __init__ toggle, explain output, and mapping package results to exit codes.",
  "type": "weighted_checklist",
  "checklist": [
    {
      "name": "Decorator regex",
      "description": "Uses pydocstyle's ignore_decorators/--ignore-decorators option to pass the user-provided regex so decorated functions matching the pattern are skipped from missing-docstring checks instead of being filtered manually.",
      "max_score": 30
    },
    {
      "name": "Property handling",
      "description": "Forwards the provided decorator names to pydocstyle's property_decorators option (or --property-decorators flag) so those methods are treated as properties and D401 property-mode messaging applies.",
      "max_score": 25
    },
    {
      "name": "Self-only init",
      "description": "Toggles pydocstyle's ignore_self_only_init setting when the allow flag is present so D107 is suppressed only for __init__(self) without extra parameters, leaving the check active by default.",
      "max_score": 25
    },
    {
      "name": "Explain output",
      "description": "Enables pydocstyle's explain/--explain option to include rule explanations in emitted messages when requested, relying on package-provided text rather than custom prose.",
      "max_score": 10
    },
    {
      "name": "Exit code mapping",
      "description": "Maps pydocstyle results (no errors vs. violations vs. option errors) to exit codes 0/1/2 following the package's documented CLI behavior instead of custom conventions.",
      "max_score": 10
    }
  ]
}

Install with Tessl CLI

npx tessl i tessl/pypi-pep257

tile.json