BallStateCBER / commentaries-cake3

CBER Data Center: Weekly Commentary
0 stars 0 forks source link

Doc comment method summaries #19

Open PhantomWatson opened 6 years ago

PhantomWatson commented 6 years ago

To stick with convention, most method summaries should describe what their methods do, rather than just repeating the name of the method. An exception to this would be constructor methods, whose purposes are obvious, and can be adequately summed up with "Constructor method".

For instance, TagsTable::getAllWithCounts() is summarized as

getAllWithCounts method

I'd suggest changing it to something like

Returns an array of tags with 'count' elements added