python / python/cpython

Docs out of date for getcoroutinestate?

Open
#101,432 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Documentation

The docs for inspect.getcoroutinestate state:

will accept any coroutine-like object that has cr_running and cr_frame attributes.

However, it seems as if as of py3.11 you also need a cr_suspended attribute, I believe due to b04dfbbe4bd7071d46c8688c2263726ea31d33cd.

Linked PRs
  • gh-101435

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

Open the inspect.getcoroutinestate documentation linked in the issue and review the referenced commit b04dfbbe4bd7071d46c8688c2263726ea31d33cd. Confirm the required coroutine attributes for Python 3.11, then ensure the documentation describes that behavior accurately. Check linked PR gh-101435 before starting, since it may already address the issue.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.