pdoc adds numpy functions to the html of one of my modules
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I just installed pdoc3 in an Anaconda virtual environment and generated the htmls of a group of modules. The html are all generated but I get the next user warning in the process:
_html_mako:329: UserWarning: Error handling return annotation for <Function 'morphoHeart_modules.morphoHeart_funcContours.rand'>
_html_mako:329: UserWarning: Error handling return annotation for <Function 'morphoHeart_modules.morphoHeart_funcContours.randn'>
and when I open the module (morphoHeart_funcContours) a lot of functions from numpy.random have been added to the module. See images below.
I double checked and I don't use the random functions of numpy anywhere and any of my variables have a name similar to rand.
Is there a way I can fix this?
Hope to hear from you soon.
best,
Juliana
Additional info
- pdoc version: 0.9.2
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
The report names no repository files or tests. Start by reproducing the warning with pdoc3 0.9.2 in an Anaconda environment on the reported module, then trace how its imported numpy.random functions enter the generated HTML. Done means the warnings are resolved and unrelated numpy.random functions no longer appear in the module documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100