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.

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

Support rendering additional markdown notation in HTML reporting #847

Open
3 tasks
schrolla opened this issue Jan 24, 2024 · 0 comments
Open
3 tasks

Support rendering additional markdown notation in HTML reporting #847

schrolla opened this issue Jan 24, 2024 · 0 comments
Labels
enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@schrolla
Copy link
Collaborator

schrolla commented Jan 24, 2024

💡 Summary

The current rendering support for markdown in the HTML reporting handles bold with asterisks and italics with underscore, but other markdown notation for bold and italics are not. This issue is to enhance rendering to handle additional cases to prevent incorrect rendering when alternate notation is used.

Motivation and context

Easy to read assessment reports enhance the users ability to review results. Text hints such as boldface and italics help emphasize critical information in the results. Supporting additional notation also prevents accidental creation of raw markdown artifacts showing in the resulting HTML reports.

Implementation notes

Implementation would be to:

  • Identify and verify additional notations to support
  • Add new notation detection and rendering to the report creation process
  • Add new unit tests to validate correct functioning of these new renderings

Initial additional candidate notations include:
italic asterisk
bold underscore
bold italic underscore asterisk mix
bold italic underscore only
bold italic asterisk only

Acceptance criteria

  • Candidate notations have been identified and agreed upon by the dev team
  • New notations selected are correctly rendered in HTML reports by ScubaGear
  • Unit tests adequately cover both correct and incorrect inputs and pass successfully
@schrolla schrolla added the enhancement This issue or pull request will add new or improve existing functionality label Jan 24, 2024
@schrolla schrolla added this to the Backlog milestone Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant