python / python/cpython

Rework `PyObject_IsSubclass` documentation

Open
#140,160 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs topic-C-API
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

PyObject_IsSubclass docs should probably be worded more succinctly and to the point

Originally posted by @erlend-aasland in https://github.com/python/cpython/pull/102554#pullrequestreview-3238838324

Linked PRs
  • gh-140236
  • gh-140346

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 PyObject_IsSubclass entry in the Python C API object documentation and compare its current wording with the request. The work is done when that entry is more succinct and to the point; check linked PRs gh-140236 and gh-140346 for the existing work.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.