search

PHPCSStandards / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
906 stars 55 forks source link

Documentation: improve information about Report data format + remove unused foreach keys #523

Closed jrfnl closed 3 months ago

jrfnl commented 4 months ago

Description

Follow up on PR #446

Documentation: improve information about report data format

This commit adds detailed information about the array format Report classes receive in the generateFileReport() method to the Report interface and to the Reporter::prepareFileReport() method which prepares the data.

It also makes the parameter specification in the individual reports a little more specific and references the Report interface for further details.

CS/QA: remove unused foreach keys from report code

As the array format is now documented, these unused variables are no longer needed for documentation purposes.

Suggested changelog entry

N/A

Related issues/external references

Related to https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/446#discussion_r1573936634

jrfnl commented 4 months ago

Fixed a typo in the first commit, which @fredden pointed out to me. No other changes.