Skip to content

Commit 3f4bb72

Browse files
committed
fix(codegen): use repr() for list items in examples
str() on string list items renders as [a, b], indistinguishable from bare identifiers. repr() renders as ['a', 'b'] so strings are visually distinct from numbers.
1 parent 14e6ac7 commit 3f4bb72

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

packages/overture-schema-codegen/src/overture/schema/codegen/markdown_renderer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ def _format_example_value(value: object) -> str:
178178
return f"`{_truncate(value)}`"
179179

180180
if isinstance(value, list):
181-
items = ", ".join(str(item) for item in value)
181+
items = ", ".join(repr(item) for item in value)
182182
return f"`{_truncate(f'[{items}]')}`"
183183

184184
if isinstance(value, dict):

packages/overture-schema-codegen/tests/test_markdown_renderer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@ def test_list_renders_comma_separated(self) -> None:
996996
"""Lists render as backtick-wrapped comma-separated values."""
997997

998998
assert _format_example_value([1, 2, 3]) == "`[1, 2, 3]`"
999-
assert _format_example_value(["a", "b"]) == "`[a, b]`"
999+
assert _format_example_value(["a", "b"]) == "`['a', 'b']`"
10001000
assert _format_example_value([]) == "`[]`"
10011001

10021002
def test_long_list_truncated(self) -> None:

0 commit comments

Comments
 (0)