Fix spacing between :rtype: and directives
#294
Conversation
If the `:rtype:` field is being inserted immediately before a directive, we must ensure there is a blank line between the two to avoid a Sphinx warning.
|
I'm not clear why the docstring complexity flake8 is failing here, when I haven't touched the docstring. |
|
cc @hoodmane |
The extra nested if caused it to pop over the top of the configured McCabe complexity measure.
|
I added an assertion about the warning within the current testing setup, though it feels like a fairly fragile test. I'd generally have preferred to just have all warnings treated as errors (except explicit overrides) within that test, but there are other warnings that would be triggered, and I'm not so familiar with your testing structure to make that change. To satisfy the complexity checker I had to completely split the containing function, rather than the more minimal change that's only in the first commit. The logical changeset is the same as 3966fb3, but it's hard to see from the diff. |
|
+1 for whitelisting warnings to allow rather than blacklisting warnings to not allow. |
If the
:rtype:field is being inserted immediately before a directive, we must ensure there is a blank line between the two to avoid a Sphinx warning.Given that #290, which added this behaviour, already added a suitable test that emits a warning that doesn't fail the suite, I wasn't clear on how best to add a further test for this.
Fix #293.