python / python/cpython

Document functools.cached_property supports value updating and clearing

Open
#82,734 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.8 (EOL) docs stdlib type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 38553
Nosy @hongweipeng, @EpicWink

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-10-21.23:53:20.815>
labels = ['3.8', 'type-feature', 'library', 'docs']
title = 'Document functools.cached_property supports value updating and clearing'
updated_at = <Date 2019-10-22.03:16:10.127>
user = 'https://github.com/EpicWink'

bugs.python.org fields:

activity = <Date 2019-10-22.03:16:10.127>
actor = 'Epic_Wink'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2019-10-21.23:53:20.815>
creator = 'Epic_Wink'
dependencies = []
files = []
hgrepos = []
issue_num = 38553
keywords = []
message_count = 3.0
messages = ['355110', '355112', '355114']
nosy_count = 3.0
nosy_names = ['docs@python', 'hongweipeng', 'Epic_Wink']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue38553'
versions = ['Python 3.8']

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

Start by locating the documentation entry for functools.cached_property in the CPython repository and reviewing its current description. Document that cached values can be updated and cleared, using the issue title as the scope. Done means the documented behavior matches the supported API.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.