Skip to content

Pilot ruff's pydocstyle (D, Google convention) and pyupgrade (UP) rules on forgelm/ #921

Open

Description

@cemililik

Deferred work · F-PR29-A7-10 · severity Low · cost ~1 day · recorded in docs/roadmap/risks-and-decisions.md:89

Summary

[tool.ruff.lint] selects only F, E9, W, B and I, so nothing enforces the Google-style docstrings coding.md requires. A dry run with ruff 0.15.21 on forgelm/ reports 104 pydocstyle violations under the Google convention (18 auto-fixable) and 1,728 pyupgrade violations (1,578 auto-fixable). The PR #29 review deferred this as a one-day pilot scoped to forgelm/, noting that UP is the smaller win and could land first.

Condition or budget

None recorded (the row still names v0.6.x).

State today (re-checked 2026-10-09)

pyproject.toml still selects ["F", "E9", "W", "B", "I"]; no pydocstyle configuration exists.

Related

#643 asks to add E722 / BLE to the selection — a different rule set.

Acceptance criteria

  • UP is enabled for forgelm/ with its auto-fixes applied, or rejected with a reason.
  • D with convention = "google" is piloted on forgelm/ and either adopted (violations fixed) or rejected with a recorded reason.
  • The row is removed from the deferral table and the CHANGELOG names its ID (the table's removal contract).

Recorded in docs/roadmap/risks-and-decisions.md (read at f94595f) and re-checked against the code on 2026-10-09. The row leaves that table only when the fix is on main, the CHANGELOG names its ID and any promised guard exists.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: dev-toolingCode area: dev-toolingseverity: lowMinor defect, inaccuracy or rough edgesource: roadmapPlanned or deferred work recorded in docs/roadmap/wave: 4Roadmap wave 4: low / info / watch, when touching the module

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions