A param description that introduces an RST code block with :: captures
the block's indented content as part of the description text. The SIG306
check looks at the last character of the description, and code block
content typically doesn't end with a sentence terminator, so the check
fires a false positive.
Example:
def func(x) -> None:
"""Summary.
:param x: Example usage::
foo(x=1)
"""
Expected: no SIG306, since the prose portion of the description ends
correctly and the trailing content is a code block.
A param description that introduces an RST code block with
::capturesthe block's indented content as part of the description text. The SIG306
check looks at the last character of the description, and code block
content typically doesn't end with a sentence terminator, so the check
fires a false positive.
Example:
Expected: no SIG306, since the prose portion of the description ends
correctly and the trailing content is a code block.