`subprocess.Popen` is documented as `pdoc.extract._PdocDefusedPopen`
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
class Bar:
foo: subprocess.Popen[str]
I realize that this substitution protects against surprises during doc generation, but perhaps it can be rendered as the original string in the docs?
System Information
❯ pdoc --version
pdoc: 15.0.4
Python: 3.12.10
Platform: macOS-14.4-arm64-arm-64bit
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 issue with the shown Bar annotation using pdoc 15.0.4, then inspect how pdoc.extract._PdocDefusedPopen is represented during documentation generation. Done means the generated documentation renders the original subprocess.Popen type instead of pdoc.extract._PdocDefusedPopen.
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