Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

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

wants to merge 2 commits into from

Commits on Jun 7, 2024

  1. 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.
    @jrfnl
    jrfnl committed Jun 7, 2024
    Configuration menu
    Copy the full SHA
    3107205 View commit details
    Browse the repository at this point in the history

  2. 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.

Co-authored-by: Klaus Purer <klaus.purer@protonmail.ch>
    @jrfnl @klausi
    jrfnl and klausi committed Jun 7, 2024
    Configuration menu
    Copy the full SHA
    52c891a View commit details
    Browse the repository at this point in the history