aio-libs / multidict / 36182231092

87%

push

github

Rename helpers whose names no longer say what they do (#1593)

<!-- Thank you for your contribution! -->

## What do these changes do?

Renames helpers whose names no longer say what they do:

- `md_del_at_for_upd_deferred()` -> `md_half_delete_for_upd()`: it does
not delete the entry, it half-deletes it (key and value only; identity,
hash and index stay live), which is what its own comment calls it. Its
unused `slot` parameter is dropped.
- `_md_resize_for_update()` -> `_md_resize_for_upd()`, matching
`md_reserve_for_upd()` and `md_add_for_upd()`.
- `_del_at_for_upd()` -> `_half_delete_for_upd()` in the pure Python
backend, to match.
- `multdicit_method_extend_doc`, `MultDict_doc`, `CIMultDict_doc`,
`MultDictProxy_doc`, `CIMultDictProxy_doc` -> `multidict_extend_doc`,
`multidict_doc`, `cimultidict_doc`, `multidict_proxy_doc`,
`cimultidict_proxy_doc`: misspelled, and cased unlike every other
`*_doc`.

## Are there changes in behavior for the user?

No.

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

No.

## Related issue number

N/A

## Checklist

- [x] I think the code is well written
- [x] Unit tests for the changes exist (no behavior change; the existing
suite covers these paths)
- [x] Documentation reflects the changes (N/A, internal only)
- [ ] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt` (N/A)
- [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`

Drafted with Claude Code (Claude Opus 5.5); pending review by @asvetlov
before leaving draft.

<details>
<summary>Agent run details (optional, for reviewers)</summary>

Tests: `pytest -q` on 3.14.7 (C, 2756 passed), 3.10.17 (C, 2756 passed),
3.14.7t with `MULTIDICT_DEBUG_BUILD=1` (2732 passed); pure Python leg
with `MULTIDICT_NO_EXTENSIONS=1 ... --no-c-extensions` (1296 passed).
Lint: pre-commit (clang-format, ruff, mypy) and `make doc-spelling`
p... (continued)

780 of 1560 branches covered (50.0%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

8164 of 8710 relevant lines covered (93.73%)

1.87 hits per line