Skip to content

docs: Update spelling wordlist and AGENTS.md checklist#1373

Open
pctablet505 wants to merge 2 commits into
aio-libs:masterfrom
pctablet505:fix-1343-multidict
Open

docs: Update spelling wordlist and AGENTS.md checklist#1373
pctablet505 wants to merge 2 commits into
aio-libs:masterfrom
pctablet505:fix-1343-multidict

Conversation

@pctablet505

Copy link
Copy Markdown

What do these changes do?

Add unparseable to docs/spelling_wordlist.txt and backfill other
technical words already used in CHANGES.rst that the docs spell check
flags. Also add a make doc-spelling checklist item to the agent pull
request template in AGENTS.md.

Are there changes in behavior for the user?

No.

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

No.

Related issue number

Fixes #1343

Checklist

  • I think the code is well written
  • N/A Unit tests for the changes exist
  • Documentation reflects the changes
  • N/A If you provide code modification, please add yourself to CONTRIBUTORS.txt
  • Add a new news fragment into the CHANGES/ folder
  • make doc-spelling passes and any new technical words are added to docs/spelling_wordlist.txt

Drafted with Kimi Code CLI; reviewed by operator.

@psf-chronographer psf-chronographer Bot added the bot:chronographer:provided There is a change note present in this PR label Jul 15, 2026
@codspeed-hq

codspeed-hq Bot commented Jul 15, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 242 untouched benchmarks


Comparing pctablet505:fix-1343-multidict (42bbe63) with master (2aed5c2)

Open in CodSpeed

Comment thread CHANGES/1343.contrib.1.rst Outdated
Comment thread docs/spelling_wordlist.txt
Comment thread docs/spelling_wordlist.txt

@Vizonex Vizonex left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a couple of changes that need to be made before I can reasonibly approve this upcoming pull request as there are words and other details that may need clarification in the timeline/changelog.

Comment thread AGENTS.md
- [x] Documentation reflects the changes
- [ ] If you provide code modification, please add yourself to `CONTRIBUTORS.txt`
- [x] Add a new news fragment into the `CHANGES/` folder
- [x] `make doc-spelling` passes and any new technical words are added to `docs/spelling_wordlist.txt`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a reasonable inclusion to add in however what I've explained above might need taking care of before I can approve this PR.

The fragment only named 'unparseable', but the wordlist diff added
seven words. Listing all of them so the changelog accurately reflects
the change.
@pctablet505
pctablet505 marked this pull request as ready for review July 16, 2026 05:13
@pctablet505
pctablet505 requested a review from Vizonex July 16, 2026 05:13

@Vizonex Vizonex left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much improved, thanks for making these changes.

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