python / python/cpython

picklable or pickleable?

Open
#125,787 19 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Currently the spellings "picklable" (24 times) and "pickleable" (4 times) both appear in our documentation. We should pick one for consistency, and perhaps document it in the devguide.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the documentation for all occurrences of “picklable” and “pickleable,” then review the surrounding wording and the devguide context. Standardize the documentation on one spelling and add the spelling guidance to the devguide, with no remaining inconsistent uses.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.