Documentation: improve information about Report data format + remove unused foreach keys #523
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
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.
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
force-pushed
the
feature/docs-improve-reports-array-format-info
branch
from
5461454
to
52c891a
Compare
fredden
approved these changes
Jun 7, 2024
|
Fixed a typo in the first commit, which @fredden pointed out to me. No other changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Follow up on PR #446
Documentation: improve information about report data format
This commit adds detailed information about the array format
Reportclasses receive in thegenerateFileReport()method to theReportinterface and to theReporter::prepareFileReport()method which prepares the data.It also makes the parameter specification in the individual reports a little more specific and references the
Reportinterface 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 #446 (comment)