Skip to content

docs(contributing): paraphrase the quoted rulings on the conventions pages, and stop asserting them as literal strings #949

Description

@JarryShaw

Describe the bug

The convention pages record the maintainer's design rulings by block-quoting him verbatim, and several tests assert those quoted sentences as literal strings. He has asked to be paraphrased instead (#918). Two problems, one stylistic and one functional:

  1. The pages read like a transcript rather than a set of conventions.
  2. His casual phrasing is a build dependency. tests/project/test_conventions_doc_claims.py asserts the literal 'I prefer (2) directly.' and 'I lean on 1.' appear on a page, so a one-line reply in a thread is load-bearing in CI.

Reproduction

$ grep -rc verbatim docs/source/contributing/conventions/*.rst
extension-header-subclassing.rst:2
mint-criterion.rst:3
registry-protocol.rst:7
sentinel-convention.rst:5

$ grep -n "assertIn('I prefer\|assertIn('I lean\|not to be loud" tests/project/test_conventions_doc_claims.py
854:        self.assertIn('they should follow house convention and not to be loud', flat,
891:        self.assertIn('I prefer (2) directly.', flat,
893:        self.assertIn('I lean on 1.', flat,

Expected behavior

Paraphrase the substance, keep the attribution by issue number, and pin the claim rather than the wording:

Scope

  • The four (soon five) pages under docs/source/contributing/conventions/.
  • Every assertIn in tests/project/ that pins a quoted sentence.
  • Out of scope: the quotes docs(contributing): record the get-override rulings on the conventions page (#918) #948 itself introduces — that PR is paraphrasing its own four as part of its current revision. And historical issue/PR comments, which stay as written; rewriting weeks of threads is noise and the originals are his words in their own context.

Notes

System information

  • pcapkit commit 210bdb419, Python 3.14.7, CPython, Linux.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreMaintenance work: tooling, repo hygiene, no library behaviour changedocsPull requests that change documentation only (docs: subject prefix)testPull requests that add or correct tests (test: subject prefix)

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions