SIG305 (description is not capitalized) fires when a parameter description contains a sentence fragment beginning with a known abbreviation such as e.g. or i.e..
sentence_tokenizer does not split on these abbreviations, but after a previous sentence split they can appear at the start of the remaining fragment. The lowercase letter belongs to the abbreviation, not to a genuine uncapitalized sentence start, so SIG305 should not fire.
def func(x) -> None:
"""Summary.
:param x: Some config value. e.g. use 42 for normal mode.
"""
This incorrectly reports SIG305.
SIG305 (description is not capitalized) fires when a parameter description contains a sentence fragment beginning with a known abbreviation such as
e.g.ori.e..sentence_tokenizerdoes not split on these abbreviations, but after a previous sentence split they can appear at the start of the remaining fragment. The lowercase letter belongs to the abbreviation, not to a genuine uncapitalized sentence start, so SIG305 should not fire.This incorrectly reports SIG305.