Skip to content

Doc comment method summaries #19

@PhantomWatson

Description

@PhantomWatson

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions