In testing 0.8.0-alpha.1, I'm being prompted via MediaWiki.Commenting.FunctionComment.Missing to write function comments for __construct which feels a little unnecessary.
Description
Description
Details
Details
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Don't require documentation for constructors without parameters | mediawiki/tools/codesniffer | master | +29 -3 |
Event Timeline
Comment Actions
You can just document the constructor parameters, and it'll pass.
I think it's worth documenting parameters for every method, including constructors. But no need, as you say, to write something like "Creates a new Blah" as the method description.
Comment Actions
Change 353618 had a related patch set uploaded (by Legoktm; owner: Legoktm):
[mediawiki/tools/codesniffer@master] Don't require documentation for constructors without parameters
Comment Actions
Change 353618 merged by jenkins-bot:
[mediawiki/tools/codesniffer@master] Don't require documentation for constructors without parameters