Because we also were not recording empty descriptions as errors (which I believe mkdocstrings interprets and reports as warnings) there was nothing to tell the user whypython -m mkdocs build had thrown a Nonetype error.
So I:
Recorded missing descriptions as errors.
Changed the code to return all missing descriptions as "" instead of None.
This should fix https://github.com/mkdocstrings/mkdocstrings/pull/397 and #137 .
The problem was that empty descriptions were being returned as None in
Parameters
andExceptions
blocks instead of""
.That None eventually made it to this: https://github.com/mkdocstrings/mkdocstrings/blob/master/src/mkdocstrings/handlers/base.py#L219
And that passed it here: https://github.com/Python-Markdown/markdown/blob/master/markdown/core.py#L225
And later in that function we get a Nonetype error: https://github.com/Python-Markdown/markdown/blob/master/markdown/core.py#L248
Because we also were not recording empty descriptions as errors (which I believe mkdocstrings interprets and reports as warnings) there was nothing to tell the user why
python -m mkdocs build
had thrown a Nonetype error.So I:
""
instead ofNone
.