Fix duplicate-word typos in docstrings#2101
Conversation
|
Heads-up on the red CI: the failing The other lint hooks (Static Word Checks, Check Documentation, ruff) all pass here, and running I opened #2102 to pin |
|
Updated: I folded the
Closing #2102 as superseded by this. Happy to split it back out if you'd prefer the tooling fix as a standalone PR. |
Remove accidental repeated words in two public API docstrings: - Redditor.multireddits: "to to get" -> "to get" - UserSubreddit ``subscribers`` attribute: "unless unless the" -> "unless the" Both render in the published API documentation. Also add myself to the Documentation Contributors list in AUTHORS.rst. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
I rebased this onto main and dropped the |
Summary
Two public API docstrings contain accidental repeated words. This fixes both:
Redditor.multireddits— "For example, to to get ..." → "For example, to get ..." (praw/models/reddit/redditor.py)UserSubredditsubscribersattribute — "Count of subscribers. This will be0unless unless the authenticated user is a moderator." → "...0unless the ..." (praw/models/reddit/user_subreddit.py)Both strings render in the published API documentation, so the typos are user-visible.
Changes
AUTHORS.rst(per the contributing guide, for a first contribution).No
CHANGES.rstentry, as this is a documentation-only fix with no behavioral change.Verification
ruff checkpasses on both edited files.user_subreddit.pyedit keeps the RST simple-table wrapping intact (the description column is 58 chars wide; the edited line is well within it and the following word still wraps to the next line), sodocstrfmtreformats nothing.