← Back to context Comment by rumno0 21 hours ago Yeah some times godoc comments look crap by necessity 4 comments rumno0 Reply fainpul 21 hours ago 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. rumno0 20 hours ago I disagree - you should have docstring and I don't think this is worse by having it... its just not ideal maleldil 15 hours ago Every public item should have a docstring, even if it's just to indicate that there's nothing special about the item. hrmtst93837 19 hours ago Boilerplate docstrings are lint that spreads, and stale ones are worse, I've seen sevreity fields documented less clearly than the code they annotate.
fainpul 21 hours ago 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. rumno0 20 hours ago I disagree - you should have docstring and I don't think this is worse by having it... its just not ideal maleldil 15 hours ago Every public item should have a docstring, even if it's just to indicate that there's nothing special about the item. hrmtst93837 19 hours ago Boilerplate docstrings are lint that spreads, and stale ones are worse, I've seen sevreity fields documented less clearly than the code they annotate.
rumno0 20 hours ago I disagree - you should have docstring and I don't think this is worse by having it... its just not ideal
maleldil 15 hours ago Every public item should have a docstring, even if it's just to indicate that there's nothing special about the item.
hrmtst93837 19 hours ago Boilerplate docstrings are lint that spreads, and stale ones are worse, I've seen sevreity fields documented less clearly than the code they annotate.
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.
Boilerplate docstrings are lint that spreads, and stale ones are worse, I've seen sevreity fields documented less clearly than the code they annotate.