← Back to issue list

Auto-format documentation source?

View original Github issue

Metadata

Project
starbase
Number
#308
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action: keep open

Reason: Maintainer medubelko substantively engaged on 2025-01-06, stating the choice 'would need fairly rigorous testing against our Starter Pack conventions' and flagging RST/MD readability bugbears, so the issue was assessed rather than left untriaged. However, no formatter has been adopted or decided upon, and the docs/ tree still exists, so it is not demonstrably obsolete despite ~16 months of inactivity. Confidence is moderate because repo tooling failed (no pinned SHA), preventing verification that no formatter was later added.

Impact: 25 Quick Win: 13.75 Staleness: 70 Complexity: 45 Confidence: 60 Support Request: 10

Issue body

Should we auto-format our documentation source? The only formatter I know of right now that doesn't appear to be entirely abandoned is [docstrfmt](https://github.com/LilSpazJoekp/docstrfmt) - maybe we can use it, since it'll format both the docstrings and the rst files?

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 25
Quick Win: 13.75
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 40
Confidence: 70
Support Request: 10
needs triage Proposes auto-formatting documentation source and docstrings using docstrfmt. Requires rigorous testing against Starter Pack conventions and validation of RST/MD readability. Currently under discussion pending formatter evaluation.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.