Pointed out at https://gerrit.wikimedia.org/r/c/mediawiki/tools/codesniffer/+/661937/ that there isn't a place these are currently documented. There should be
Description
Description
Details
Details
Subject | Repo | Branch | Lines +/- | |
---|---|---|---|---|
README: Add Configuration section to document adjustable sniffs | mediawiki/tools/codesniffer | master | +62 -0 |
Event Timeline
Comment Actions
Scanning through the existing sniffs manually shows the following configuration properties:
FullQualifiedClassNameSniff: allowMainNamespace, allowInheritance, allowFunctions ClassLevelLicenseSniff: license PrefixedGlobalFunctionsSniff: ignoreList ValidGlobalNameSniff: allowedPrefixes, ignoreList ExtendClassUsageSniff: nonConfigGlobals
Comment Actions
At least in the sniffs I wrote you will find longer pieces of documentation in comments at the top of the class as well as on these properties. I agree we should copy-paste them e.g. into the libraries README.md. That's where I would start looking for documentation.
Comment Actions
Change 682272 had a related patch set uploaded (by Umherirrender; author: Umherirrender):
[mediawiki/tools/codesniffer@master] Add Customization section to README
Comment Actions
Change 682272 merged by jenkins-bot:
[mediawiki/tools/codesniffer@master] README: Add Configuration section to document adjustable sniffs