python / python/cpython

Fix undocumented method `CookieJar.clear_expired_cookies` in lib `http.cookiejar`

Open
#135,885 0 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

Although there is low possibility to call this method if you are using DefaultCookiePolicy, but as a method of CookieJar that could be used(do not start with _, and would be used when users are customizing their own policies), the method is supposed to be documented.

IMO we can document it in case of ppl are customizing their own policy instead of using DefaultCookiePolicy, while they need this func to write their own expiration logic.

PR: #135882

Linked PRs
  • gh-135882

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

Review the documentation for http.cookiejar and the existing PR #135882, focusing on the public CookieJar.clear_expired_cookies method. Done means the method is documented for users implementing custom cookie policies without changing its behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.