Warning generated for `__pdoc__[submodule] = False`, but behaviour correct
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
I expect no warnings.
Actual Behavior
<some path>/python3.8/site-packages/pdoc/__init__.py:706: UserWarning: __pdoc__-overriden key 'module' does not exist in module 'mwe'
warn('__pdoc__-overriden key {!r} does not exist '
Steps to Reproduce
mkdir mwe
mkvirtualenv mwe
pip install pdoc3
echo "__pdoc__ = {
'module': False
}
" > mwe/__init__.py
echo '"""Some documentation"""
' > mwe/module.py
pdoc3 --html mwe
Additional info
MarkupSafe-1.1.1mako-1.1.3markdown-3.2.2pdoc3-0.8.1
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
Reproduce the warning with the provided virtualenv setup and pdoc3 --html mwe command, using mwe/__init__.py and mwe/module.py. Trace the warning shown from pdoc/__init__.py:706; done means __pdoc__ = {'module': False} produces no warning while the module remains excluded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100