canonical / canonical/starbase

Auto-format documentation source?

Open
#308 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Makefile
Stars
13
Forks
6
Avg merge
23h 56m
Merged PRs (30d)
9

Description

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?

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by evaluating whether docstrfmt is maintained and whether it formats both docstrings and RST files as needed. Done would require a decided formatter approach and a defined way to apply it to the documentation source.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.