From 78b649cf391dfd9dcd4ef655f8acdde54e89199f Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Wed, 14 Jan 2026 15:37:50 +0100 Subject: [PATCH] fix: yaml in output format do not convert object to str --- src/rougail/output_doc/example.py | 6 +++--- src/rougail/output_doc/output/asciidoc.py | 2 +- src/rougail/output_doc/output/console.py | 2 +- src/rougail/output_doc/output/github.py | 2 +- src/rougail/output_doc/output/html.py | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/rougail/output_doc/example.py b/src/rougail/output_doc/example.py index d4d5f1f41..d05cbf178 100644 --- a/src/rougail/output_doc/example.py +++ b/src/rougail/output_doc/example.py @@ -21,7 +21,7 @@ from ruamel.yaml import CommentedMap from ruamel.yaml.representer import RoundTripRepresenter -from .utils import _, calc_path +from .utils import _, calc_path, dump # XXX explicit null (see rougail-output-formatter @@ -69,7 +69,7 @@ class Examples: # pylint: disable=no-member,too-few-public-methods self.formatter.title( _("Example with mandatory variables not filled in"), self.level ), - self.formatter.yaml(examples_mandatories), + self.formatter.yaml(dump(examples_mandatories)), self.formatter.end_family(self.level), ]) if self.examples: @@ -84,7 +84,7 @@ class Examples: # pylint: disable=no-member,too-few-public-methods datas.extend([self.formatter.title( _("Example with all variables modifiable"), self.level ), - self.formatter.yaml(examples), + self.formatter.yaml(dump(examples)), self.formatter.end_family(self.level), ]) return self.formatter.compute(datas) diff --git a/src/rougail/output_doc/output/asciidoc.py b/src/rougail/output_doc/output/asciidoc.py index 70bc9c4ee..56c5b20ca 100644 --- a/src/rougail/output_doc/output/asciidoc.py +++ b/src/rougail/output_doc/output/asciidoc.py @@ -124,7 +124,7 @@ class Formatter(CommonFormatter): def yaml(self, _dump: dict) -> str: """Dump yaml part of documentation""" - return f"[,yaml]\n----\n---\n{dump(_dump)}\n----\n" + return f"[,yaml]\n----\n---\n{_dump}\n----\n" def tabular(self, with_header: bool = True) -> str: """Transform list to a tabular in string format diff --git a/src/rougail/output_doc/output/console.py b/src/rougail/output_doc/output/console.py index e35e1784a..cf6ece822 100644 --- a/src/rougail/output_doc/output/console.py +++ b/src/rougail/output_doc/output/console.py @@ -164,7 +164,7 @@ class Formatter(CommonFormatter): def yaml(self, _dump): """Dump yaml part of documentation""" - return self.rich_syntaxt(f'---\n{dump(_dump)}', 'yaml') + return self.rich_syntaxt(f'---\n{_dump}', 'yaml') def link( self, diff --git a/src/rougail/output_doc/output/github.py b/src/rougail/output_doc/output/github.py index f0d754066..9cae5f717 100644 --- a/src/rougail/output_doc/output/github.py +++ b/src/rougail/output_doc/output/github.py @@ -147,7 +147,7 @@ class Formatter(CommonFormatter): def yaml(self, _dump): """Dump yaml part of documentation""" - return f"```yaml\n---\n{dump(_dump)}\n```\n" + return f"```yaml\n---\n{_dump}\n```\n" def link_variable(self, path: str, diff --git a/src/rougail/output_doc/output/html.py b/src/rougail/output_doc/output/html.py index b263ada78..6bd4896cd 100644 --- a/src/rougail/output_doc/output/html.py +++ b/src/rougail/output_doc/output/html.py @@ -124,7 +124,7 @@ class Formatter(CommonFormatter): def yaml(self, _dump: dict) -> str: """Dump yaml part of documentation""" - return f"
{dump(_dump)}
" + return f"
{_dump}
" def link( self,