[doc] Add section on pickling to exceptions documentation
Open
Nobody has claimed this yet.
3.10
3.11
3.9 (EOL)
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 37287 |
|---|---|
| Nosy | @gpshead, @brianquinlan, @raabf, @iritkatriel |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2019-06-14.23:30:45.457>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = '[doc] Add section on pickling to exceptions documentation'
updated_at = <Date 2022-01-06.16:27:39.149>
user = 'https://github.com/brianquinlan'
bugs.python.org fields:
activity = <Date 2022-01-06.16:27:39.149>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-06-14.23:30:45.457>
creator = 'bquinlan'
dependencies = []
files = ['48420']
hgrepos = []
issue_num = 37287
keywords = []
message_count = 4.0
messages = ['345647', '345909', '348506', '409872']
nosy_count = 5.0
nosy_names = ['gregory.p.smith', 'bquinlan', 'docs@python', 'raabf', 'iritkatriel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue37287'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked nopickle.py example and the existing exceptions documentation to understand the pickling behavior that needs coverage. Add a section explaining pickling exceptions, then verify that the documentation clearly reflects the example and the intended behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100