Document docs spell check in AGENTS.md, add 'unparseable'#1344
Document docs spell check in AGENTS.md, add 'unparseable'#1344aiolibsbot wants to merge 2 commits into
Conversation
|
You solved two things in a single PR. unparseable was the example. Just needed a AGENTS.md update and the changelog here. nothing more |
|
@aiolibsbot rr |
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 🟡 Important1. Remove `unparseable` entry per maintainer feedback (`docs/spelling_wordlist.txt`, L106)@bdraco has explicitly requested that this change be dropped (see comment 4468970682): Suggested fix: revert this file entirely and update the CHANGES/1343.contrib.rst wording to drop the reference to adding 🟢 Suggestions1. Update fragment wording if wordlist change is dropped (`CHANGES/1343.contrib.rst`, L1-5)If you revert the The Checklist
SummaryThe AGENTS.md addition is well-written and addresses the stated issue (#1343) clearly. However, the maintainer @bdraco has explicitly flagged that the Automated review by Kōan1c8eade |
Acknowledged — you're right that |
Rebase with requested adjustmentsBranch Changes applied
StatsActions performed
CI statusCI will be checked asynchronously. Automated by Kōan |
|
going to do another agents.md update so I'll roll this into a manual pr |
- 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.
What do these changes do?
Add a section to
AGENTS.mdreminding agents to runmake doc-spellingbefore pushing, since the CI
sphinxcontrib.spellingbuild treats anyunknown word in a
CHANGES/*.rstfragment as a hard failure. Addunparseabletodocs/spelling_wordlist.txt, which is the word thattripped #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
CONTRIBUTORS.txt- N/A, noCONTRIBUTORS.txtin this repoCHANGES/folderDrafted 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/spellingproduces no new fragment errors after this change. Pre-existing
local hits on
CHANGES.rstare enchant-dictionary differences and donot 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