Skip to content

Document docs spell check in AGENTS.md, add 'unparseable'#1344

Closed
aiolibsbot wants to merge 2 commits into
aio-libs:masterfrom
aiolibsbot:koan/fix-issue-1343
Closed

Document docs spell check in AGENTS.md, add 'unparseable'#1344
aiolibsbot wants to merge 2 commits into
aio-libs:masterfrom
aiolibsbot:koan/fix-issue-1343

Conversation

@aiolibsbot
Copy link
Copy Markdown
Contributor

@aiolibsbot aiolibsbot commented May 17, 2026

What do these changes do?

Add a section to AGENTS.md reminding agents to run make doc-spelling
before pushing, since the CI sphinxcontrib.spelling build treats any
unknown word in a CHANGES/*.rst fragment as a hard failure. Add
unparseable to docs/spelling_wordlist.txt, which is the word that
tripped #1342.

Are there changes in behavior for the user?

No. Documentation and word-list only.

Is it a substantial burden for the maintainers to support this?

No. The new AGENTS.md section is one rule under the existing "Pull
request rules" list, and the word-list change is a single line.

Related issue number

Fixes #1343

Checklist

  • I think the code is well written
  • Unit tests for the changes exist - N/A, docs-only change
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt - N/A, no CONTRIBUTORS.txt in this repo
  • Add a new news fragment into the CHANGES/ folder

Drafted with Kōan; reviewed by :user:`bdraco`.

Agent run details (optional, for reviewers)

Spelling: python -m sphinx -b spelling -W -n --keep-going -E docs docs/_build/spelling
produces no new fragment errors after this change. Pre-existing
local hits on CHANGES.rst are enchant-dictionary differences and do
not reproduce on CI.


Quality Report

Changes: 3 files changed, 29 insertions(+)

Code scan: clean

Tests: failed (FAILED)

Branch hygiene: clean

Generated by Kōan post-mission quality pipeline

@psf-chronographer psf-chronographer Bot added the bot:chronographer:provided There is a change note present in this PR label May 17, 2026
@bdraco
Copy link
Copy Markdown
Member

bdraco commented May 17, 2026

You solved two things in a single PR.

unparseable was the example. Just needed a AGENTS.md update and the changelog here. nothing more

@bdraco
Copy link
Copy Markdown
Member

bdraco commented May 17, 2026

@aiolibsbot rr

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 17, 2026

Merging this PR will not alter performance

✅ 245 untouched benchmarks


Comparing aiolibsbot:koan/fix-issue-1343 (2b5a189) with master (6370ee2)

Open in CodSpeed

@aiolibsbot
Copy link
Copy Markdown
Contributor Author

PR Review — Document docs spell check in AGENTS.md, add 'unparseable'

The AGENTS.md addition is well-written and addresses the stated issue (#1343) clearly. However, the maintainer @bdraco has explicitly flagged that the docs/spelling_wordlist.txt change is out of scope — unparseable was an illustrative example in the prose, not a word that needs to be permanently added to the dictionary. The PR should be reduced to just the AGENTS.md section + a rewritten news fragment before merge. No correctness, security, or testing concerns — this is purely a scoping issue raised by the maintainer.


🟡 Important

1. Remove `unparseable` entry per maintainer feedback (`docs/spelling_wordlist.txt`, L106)

@bdraco has explicitly requested that this change be dropped (see comment 4468970682): unparseable was used as an illustrative example in the AGENTS.md prose, not a word that actually needs to be added to the wordlist as part of this PR. The PR scope should be reduced to just the AGENTS.md section and the news fragment.

Suggested fix: revert this file entirely and update the CHANGES/1343.contrib.rst wording to drop the reference to adding unparseable.

+unparseable

🟢 Suggestions

1. Update fragment wording if wordlist change is dropped (`CHANGES/1343.contrib.rst`, L1-5)

If you revert the docs/spelling_wordlist.txt change as @bdraco requested, this fragment also needs to be rewritten — it currently advertises the unparseable addition as a co-equal change. Something like:

Documented the docs spell check in ``AGENTS.md`` so LLM contributors
run ``make doc-spelling`` before pushing rather than burning a CI run
on a missing dictionary entry -- by :user:`aiolibsbot`.

The :user:\aiolibsbot`` credit is correctly applied per the aio-libs PR template.

Documented the docs spell check in ``AGENTS.md`` and added the
``unparseable`` entry to ``docs/spelling_wordlist.txt`` so LLM
contributors run ``make doc-spelling`` before pushing rather than
burning a CI run on a missing dictionary entry
-- by :user:`aiolibsbot`.

Checklist

  • No hardcoded secrets
  • Documentation accurate and matches code
  • News fragment present and formatted correctly
  • Scope matches maintainer expectations — warning #1
  • aio-libs PR template / :user: credit applied

Summary

The AGENTS.md addition is well-written and addresses the stated issue (#1343) clearly. However, the maintainer @bdraco has explicitly flagged that the docs/spelling_wordlist.txt change is out of scope — unparseable was an illustrative example in the prose, not a word that needs to be permanently added to the dictionary. The PR should be reduced to just the AGENTS.md section + a rewritten news fragment before merge. No correctness, security, or testing concerns — this is purely a scoping issue raised by the maintainer.


Automated review by Kōan1c8eade

@aiolibsbot
Copy link
Copy Markdown
Contributor Author

@bdraco: You solved two things in a single PR.

Acknowledged — you're right that unparseable was only meant as an example in the AGENTS.md prose, not a real wordlist entry. I'll drop the docs/spelling_wordlist.txt change and rewrite CHANGES/1343.contrib.rst so it only describes the AGENTS.md addition. That keeps the PR to the single rule under "Pull request rules" plus the changelog, as you suggested.

@aiolibsbot
Copy link
Copy Markdown
Contributor Author

Rebase with requested adjustments

Branch koan/fix-issue-1343 was rebased onto master and review feedback was applied.

Changes applied

  • Applied @bdraco feedback:
  • Reverted docs/spelling_wordlist.txt: removed unparseable entry per maintainer request (was illustrative example, not actual addition needed).
  • Rewrote CHANGES/1343.contrib.rst: dropped reference to wordlist addition, kept only AGENTS.md documentation note.

Stats

2 files changed, 27 insertions(+)
Actions performed
  • Already-solved check: negative (confidence=high, reasoning=No recent master commit documents docs spell check in AGENTS.md or adds 'unparseable' to spelling_wo)
  • Rebased koan/fix-issue-1343 onto upstream/master
  • Applied review feedback
  • Pre-push CI check: previous run still pending
  • Force-pushed koan/fix-issue-1343 to origin
  • CI check enqueued in ## CI (async)

CI status

CI will be checked asynchronously.


Automated by Kōan

@bdraco
Copy link
Copy Markdown
Member

bdraco commented May 17, 2026

going to do another agents.md update so I'll roll this into a manual pr
#1344

@bdraco bdraco closed this May 17, 2026
bdraco added a commit to bdraco/multidict that referenced this pull request May 17, 2026
- Adds "Push from a fork, not to upstream" as PR rule aio-libs#3, with
  the commands and a note on the `GH013` error you get for
  trying to push a feature branch to `aio-libs/multidict`.
- Folds in the docs spell check section from aio-libs#1344 as PR rule
  aio-libs#7, so `make doc-spelling` is documented as the pre-push
  gate; adds `codecov` to `docs/spelling_wordlist.txt` for the
  new fragment.
- Renumbers PR rules 3-6 to 4-8, and extends the news fragments
  to cover all three additions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Agents get tripped up by not checking the spelling list and wasting ci time like in

2 participants