What is the cause of the Sphinx warning "Block quote ends without a blank line; unexpected unindent" in a one line docstring

Asked Dec 18 '22 at 07:19

Active Dec 18 '22 at 07:32

Viewed 657 times

When I build my Sphinx HTML documentation, I get a warning.

checkdmarc.py:docstring of checkdmarc.BIMIRecordInWrongLocation:1: WARNING: Block quote ends without a blank line; unexpected unindent.

BIMIRecordInWrongLocation is a simple Exception class with a one line docstring.

class BIMIRecordInWrongLocation(BIMIError):
    """Raised when a BIMI record is found at the root of a domain"""

Oddly, the warning persisted even after I replaced the docstring with pass.

For context, here is the full code, and the Sphinx build log.

edited Dec 18 '22 at 07:32

asked Dec 18 '22 at 07:19

Sean W.

My guess is the differing indentation levels of the [preceding docstring](https://github.com/domainaware/checkdmarc/blob/4fcdd758f90395312a6a030aef7491bd96dc4c09/checkdmarc.py#L289-L293). If you dedent the indent by one space, it should pass. – Steve Piercy Dec 20 '22 at 08:34

0 Answers0