Sometimes when generating docs, this tool can leave trailing whitespace. For example (I added $s to the end of each line to show where the line ends):
$
Returns$
-------$
None$
$
Here you can see that before the Returns is something like \n\t\n or \n \n. This was generated with style = "google".
This is a problem for users who ant to integrate this into pre-commit as many things either remove trailing whitespace or consider it a problem. For example, pre-commit's homepage advertises first party support for a trailing whitespace checker, but many linters also support this feature as well.
Sometimes when generating docs, this tool can leave trailing whitespace. For example (I added
$s to the end of each line to show where the line ends):Here you can see that before the
Returnsis something like\n\t\nor\n \n. This was generated withstyle = "google".This is a problem for users who ant to integrate this into pre-commit as many things either remove trailing whitespace or consider it a problem. For example, pre-commit's homepage advertises first party support for a trailing whitespace checker, but many linters also support this feature as well.