Skip to content

false positive SIG305 after common abbreviations #976

Description

@jshwi

The sentence tokenizer treats a period as a sentence boundary unless the
preceding token is in a small set of known abbreviations. That set only holds
e.g., i.e., mr., dr., vs., etc. and u.s., so other common
abbreviations end a sentence and the lowercase word after them is reported as
SIG305 (description not capitalized).

Reproducer:

def function(a: int, b: int, c: int) -> None:
    """Summary.

    :param a: The threshold, cf. the parent class.
    :param b: No. of items to keep.
    :param c: The layout in fig. 3, per Smith et al. and others.
    """
$ docsig .

Each parameter description is flagged with SIG305 even though cf., no.,
fig. and et al. are abbreviations, not sentence endings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions