Skip to content

Commit

Permalink
Update generated markdown
Browse files Browse the repository at this point in the history
Signed-off-by: hoangtungdinh <11166240+hoangtungdinh@users.noreply.github.com>
  • Loading branch information
hoangtungdinh committed Sep 10, 2024
1 parent ba69831 commit 3f8b72c
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 5 deletions.
4 changes: 1 addition & 3 deletions qc_baselib/result.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,12 @@ def write_markdown_doc(self, markdown_file_path: str) -> None:
bundle_text += f"# Checker bundle: {bundle.name}\n\n"
bundle_text += f"* Build version: {bundle.version}\n"
bundle_text += f"* Description: {bundle.description}\n"
bundle_text += f"* Summary: {bundle.summary}\n"

bundle_text += "\n"
bundle_text += f"## Parameters\n\n"
param_text = ""
for param in bundle.params:
param_text += f"* {param.name}: \n"
param_text += f"* {param.name} \n"

if len(param_text) == 0:
param_text += f"* None\n"
Expand All @@ -139,7 +138,6 @@ def write_markdown_doc(self, markdown_file_path: str) -> None:
checker_text += "\n"
checker_text += f"### {checker.checker_id}\n\n"
checker_text += f"* Description: {checker.description}\n"
checker_text += f"* Summary: {checker.summary}\n"

checker_text += f"* Addressed rules:\n"
rule_text = ""
Expand Down
2 changes: 0 additions & 2 deletions tests/data/result_markdown_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@

* Build version: 0.0.1
* Description: Example checker bundle
* Summary: Tested example checkers

## Parameters

Expand All @@ -21,6 +20,5 @@
### TestChecker

* Description: Test checker
* Summary: Executed evaluation
* Addressed rules:
* test.com:qc:1.0.0:qwerty.qwerty

0 comments on commit 3f8b72c

Please sign in to comment.