No way to globally include private identifiers
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
PyDoc is wonderful! I had it up and running in minutes, and it produced beautiful docs.
But I hit an issue. We would like to use this both for docs for our developer team, as well as producing external-facing documentation. If we want to include private identifiers in our docs, we have to update add a __pdoc__ to every file. But...if we want to produce user-facing docs, we would have to remove that.
It would be really nice if there was a command-line flag to say "include all private identifiers."
Since pdoc3 is so procedural (and not class/hierarchy based) it appears this would require quite the re-architecting of the project.
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 tracing how pdoc3 handles pdoc settings and how command-line options are parsed. Determine where a global private-identifier option could fit without requiring per-file changes, then define the expected behavior for developer-facing and user-facing documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100