Skip to content

Implement human-readable sentences in the HTML report #1148

@maximearmstrong

Description

@maximearmstrong

Feature request

Currently, the HTML output uses tables to display the samples of a Notice, with the columns being the context fields.
Adding a human-readable string, such as the example provided here, would improve the readability of the report.

Is your feature request related to a problem? Please describe.
The tables in the HTML output are not so easy to read.

Proposed solution
Extend the attributes of the notices in the validator with their description and string to be formatted. This gives the notices to know their own description. The description/string could then be used in the HTML report.

Additional context
This issue has already been discussed in PR #1127 here.
This issue was also addressed in PR #1119. This work could most likely be partially reused.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature request or improvement on an existing featurevalidation reportAdding information in the report, an improvement on the interface, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions