Skip to content

Make value key its own column when rendering decision point examples #954

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

Merged
ahouseholder merged 2 commits into from
Sep 15, 2025
Merged

Make value key its own column when rendering decision point examples #954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2126a60
Make value key its own column when rendering decision point examples …
ahouseholder Sep 15, 2025
b2e9b14
fix tests
ahouseholder Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/ssvc/doc_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

from ssvc.decision_points.ssvc.base import SsvcDecisionPoint

MD_TABLE_ROW_TEMPLATE = "| {value.name} ({value.key}) | {value.definition} |"
MD_TABLE_ROW_TEMPLATE = "| {value.name} | {value.key} | {value.definition} |"


def markdown_table(dp: SsvcDecisionPoint, indent: int = 0) -> str:
Expand All @@ -43,8 +43,8 @@ def markdown_table(dp: SsvcDecisionPoint, indent: int = 0) -> str:
_indent = " " * indent
rows.append(f"{_indent}{dp.definition}")
rows.append("")
rows.append(f"{_indent}| Value | Definition |")
rows.append(f"{_indent}|:-----|:-----------|")
rows.append(f"{_indent}| Value | Key | Definition |")
rows.append(f"{_indent}|:-----|:---|:-----------|")

# add a row for each value
for value in dp.values:
Expand Down
22 changes: 11 additions & 11 deletions src/test/test_doc_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ def test_markdown_table(self):
expected = (
"test description\n"
"\n"
"| Value | Definition |\n"
"|:-----|:-----------|\n"
"| A (A) | A Definition |\n"
"| B (B) | B Definition |"
"| Value | Key | Definition |\n"
"|:-----|:---|:-----------|\n"
"| A | A | A Definition |\n"
"| B | B | B Definition |"
)

self.assertEqual(result, expected)
Expand All @@ -63,10 +63,10 @@ def test_markdown_table(self):
expected_indented = (
" test description\n"
"\n"
" | Value | Definition |\n"
" |:-----|:-----------|\n"
" | A (A) | A Definition |\n"
" | B (B) | B Definition |"
" | Value | Key | Definition |\n"
" |:-----|:---|:-----------|\n"
" | A | A | A Definition |\n"
" | B | B | B Definition |"
)

self.assertEqual(indented, expected_indented)
Expand All @@ -76,9 +76,9 @@ def test_example_block(self):
result = example_block(self.dp)

self.assertIn("!!! note", result)
self.assertIn("\n | Value | Definition |", result)
self.assertIn("\n | A (A) | A Definition |", result)
self.assertIn("\n | B (B) | B Definition |", result)
self.assertIn("\n | Value | Key | Definition |", result)
self.assertIn("\n | A | A | A Definition |", result)
self.assertIn("\n | B | B | B Definition |", result)
self.assertIn("\n ??? example", result)
self.assertIn("\n ```json", result)

Expand Down