Repository navigation
docs: a module docstring's title underline runs six past the title #2718
Description
Ruling (owner, in session): in a module docstring whose title is underlined with =, the underline is the title's length plus six, so the heading looks balanced.
"""Some Module
=================
On main at bd82b7632, most pcapkit/ module docstrings already follow it. A minority are short or long by between one and six, mostly under pcapkit/vendor/ and pcapkit/corekit/.
- Bring every module docstring with an
=title underline into line, acrosspcapkit/,tests/,util/,examples/anddocs/. - Fix the vendor crawlers' templates and any other generator that writes module docstrings, so regenerated modules keep the rule.
- Write the rule onto the conventions page, and pin it with a
tests/projectcheck.
Activity
JarryShaw commentedon Nov 3, 2026
Landed on
mainas0c0794097. It touches docs and tests only: everypcapkit/change is an underline line, and the code is AST-equal with docstrings stripped. Closing.'=' * (len(title) + 6), so no generator changed. A full regeneration keeps the rule.documentation.rst. Two new checks pin it, one on the modules and one on the templates; both fail on the previousmain.docs(changelog): fold make()'s enumeration fields, the corekit.schema…