Hacker News new | ask | show | jobs
by rumno0 82 days ago
Yeah some times godoc comments look crap by necessity
1 comments

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.

I disagree - you should have docstring and I don't think this is worse by having it... its just not ideal
Every public item should have a docstring, even if it's just to indicate that there's nothing special about the item.