Yeah some times godoc comments look crap by necessity
But you don't have to add a docstring. Cases like this are worse than no docstring at all, because it wastes the reader's time.
If you add one, at least make the effort to provide some useful information. For example which is more severe: higher or lower numbers.
But you don't have to add a docstring. Cases like this are worse than no docstring at all, because it wastes the reader's time.
If you add one, at least make the effort to provide some useful information. For example which is more severe: higher or lower numbers.