-
Notifications
You must be signed in to change notification settings - Fork 1
Pin ruff format settings explicitly in pyproject.toml #95
Copy link
Copy link
Closed
Labels
area:governancePolicies and validation rulesPolicies and validation rulescomplexity:simpleStraightforward change, minimal riskStraightforward change, minimal riskdocumentationImprovements or additions to documentationImprovements or additions to documentationpriority:mediumImportant but not blockingImportant but not blockingsize:SSmall effort (< 1 day)Small effort (< 1 day)
Metadata
Metadata
Labels
area:governancePolicies and validation rulesPolicies and validation rulescomplexity:simpleStraightforward change, minimal riskStraightforward change, minimal riskdocumentationImprovements or additions to documentationImprovements or additions to documentationpriority:mediumImportant but not blockingImportant but not blockingsize:SSmall effort (< 1 day)Small effort (< 1 day)
Context
The docs claim
ruff formatuses "double quotes, trailing commas" (workflows.md § Code style), which is currently accurate — these are ruff's defaults. However, there is no explicit[tool.ruff.format]section inpyproject.tomlto pin these settings.If ruff changes its defaults in a future release, the docs would silently become inaccurate.
Proposed change
Add an explicit
[tool.ruff.format]section topyproject.toml:This makes the contract explicit and resilient to upstream default changes.
Origin
Raised during review of #94 (docs rewrite PR).