DOC502 Raises section in response to assert

[pechersky]

DOC502 gets flagged in function docstrings where the function body has an assert condition, error_msg style, saying that there are no raise statements.

Consider the following file

def raises_assert() -> None:
    """Raises an AssertionError.
    
    Raises:
        AssertionError: foo.
    """
    assert False, "foo"

raises_assert()

When ran:

$ python assert_mwe.py
Traceback (most recent call last):
  File "/home/user/assert_mwe.py", line 9, in <module>
    raises_assert()
  File "/home/user/assert_mwe.py", line 7, in raises_assert
    assert False, "foo"
AssertionError: foo

And pydoclint complains about the file:

$  pydoclint assert_mwe.py 
assert_mwe.py
assert_mwe.py
    1: DOC502: Function `raises_assert` has a "Raises" section in the docstring, but there are not "raise" statements in the body

Could the codepath that checks for these support AssertionError when assert is found?

[jsh9]

I think this is a good suggestion. My bandwidth is a bit limited at this moment, so would you be willing to make a code change?

The logic of reporting DOC502 is here:

pydoclint/pydoclint/visitor.py

Lines 900 to 902 in 2e8af22

	if not hasRaiseStmt and docstringHasRaisesSection:
	if not self.isAbstractMethod:
	violations.append(v502)

(v502 means "Violation 502" and hence DOC502)

Thanks!