domainaware / parsedmarc

A Python package and CLI for parsing aggregate and forensic DMARC reports
https://domainaware.github.io/parsedmarc/
Apache License 2.0
966 stars 210 forks source link

Fix docstring indentations and grammar #405

Closed bencomp closed 1 year ago

bencomp commented 1 year ago

In several docstrings incorrect indentation caused errors in the rendered documentation. I also changed a few words to correct the grammar.

I did notice after committing that the indentation style varies across functions or methods. In some places, there is:

Args:
    some_arg (type): very long description
                     that continues on the next line

... whereas I just added four spaces before the continuations.