Incomplete 'function' entries in Types and Members table in inspect documentation
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
In the inspect documentation, the 'function' entries in the Types and Members table are not aligned to the FunctionType's attributes in the data model documentation section 3.2.8.1. E.g. __closure__ is missing.
Linked PRs
- gh-142976
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 with the inspect documentation's Types and Members table and compare its function entries with the FunctionType attributes in data model section 3.2.8.1. The work is done when the table is aligned with the referenced data model documentation, including the reported missing attribute such as __closure__; note that linked PR gh-142976 indicates this work is already underway.
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
- 35/100