Type of returned tuple not noted
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
Expected the type of the returned tuple to be noted as 'int' as in definition of the property.
Actual Behavior
Generated documentation notes that the returned data is a tuple, but does not note the
type of the data in tuple.
Steps to Reproduce
Ran pdoc3 on file containing above source.
Additional info
- pdoc version: pdoc3 0.9.1 (installed via pip3)
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 by reproducing the report with pdoc3 0.9.1 on the Python file shown in the attached screenshot, then trace how the generated documentation renders the property's returned tuple. Done means the documentation records the tuple element type as int, matching the property's definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100