Auto-format documentation source?
Metadata
Current evaluation
Maintainer proposal to auto-format docs source and docstrings (docstrfmt suggested); still open, with a reviewer noting it needs rigorous testing against Starter Pack conventions and RST readability concerns.
Suggested action: keep open
Reason: Authored by maintainer lengau, so it has clear maintainer sponsorship, and medubelko's2025-01-06 comment engages with it ("this would need fairly rigorous testing against our Starter Pack conventions") rather than dismissing it. Nothing in the repo resolves it: .pre-commit-config.yaml still only runs trailing-whitespace/ruff/prettier (md/yaml/json)/shfmt, docs/_dev/.pre-commit-config.yaml only runs spelling/linkcheck/woke, and a git-log search for "docstrfmt" returns no commits — so there is no evidence the docs formatting capability landed. Impact is modest (docs corpus is small and prettier already covers .md; .rst is untouched) and the open question of tool choice plus the reviewer's subjective readability criteria keep it from being turnkey, so it stays open pending design/spike work rather than being closed.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
30
Quick Win:
5
Complexity:
55
Confidence:
72
Actionability:
38
|
keep open | Maintainer proposal to auto-format docs source and docstrings (docstrfmt suggested); still open, with a reviewer noting it needs rigorous testing against Starter Pack conventions and RST readability concerns. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
8
Complexity:
35
Confidence:
60
Actionability:
40
|
keep open | Proposal to auto-format documentation source using docstrfmt for docstrings and RST files. Comment notes need for testing against Starter Pack conventions and concerns about RST/MD readability. | |
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
14
Staleness:
70
Complexity:
45
Confidence:
60
Support Request:
10
|
keep open | Discussion on whether to auto-format documentation source (docstrings and RST), proposing docstrfmt. A maintainer noted it needs rigorous testing against Starter Pack conventions. Unlabelled, undecided, inactive ~16 months. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
40
Confidence:
75
Support Request:
10
|
needs triage | Proposal to auto-format documentation using docstrfmt. Currently open with no labels or maintainer response. One contributor noted it requires rigorous testing against project conventions and raised readability concerns. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
45
Confidence:
75
Support Request:
5
|
needs triage | Proposal to auto-format documentation source using docstrfmt. Currently inactive for over a year with no maintainer assessment, labels, or implementation progress. |
Update history
No update history recorded yet.
Related work
-
Related To:
starbase#405
(confidence 70%)
Commit 18e50d3 'style: add pre-commit to auto-formatting' established the auto-formatting hook pattern this issue would extend to docs
-
Related To:
starbase#597
(confidence 60%)
Commit 79fa93c 'feat: format toml files with tombi' is the same pattern (adding a new formatter to Makefile/common.mk/pre-commit) but for TOML, not docs
-
Related To:
starbase#565
(confidence 55%)
Commit e978069 'feat(build): add shfmt tool for shell formatting' — precedent for adding a new formatter toolchain entry
Related issues
No related issues found above the similarity threshold.