From d26653d95c43d5ec7998c805af9ac83534c8994b Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 30 Mar 2026 22:28:05 +0200 Subject: [PATCH] fix: do not display {{ identifier }} in description --- src/rougail/output_doc/utils.py | 7 +++++-- .../after/rougail/00-base.yml | 1 + .../before/rougail/00-base.yml | 1 + .../40_dynamic_variable_description_mod/result.adoc | 2 +- .../40_dynamic_variable_description_mod/result.gitlab.md | 2 +- .../40_dynamic_variable_description_mod/result.html | 4 ++-- .../40_dynamic_variable_description_mod/result.md | 2 +- .../40_dynamic_variable_description_mod/result.sh | 2 +- 8 files changed, 13 insertions(+), 8 deletions(-) diff --git a/src/rougail/output_doc/utils.py b/src/rougail/output_doc/utils.py index 4b8bc47d8..888188b84 100644 --- a/src/rougail/output_doc/utils.py +++ b/src/rougail/output_doc/utils.py @@ -599,7 +599,7 @@ class CommonFormatter: force_identifiers: Optional[str], *, with_to_phrase: bool=True, - ) -> str(): + ) -> str: def _get_description(description, identifiers, delete=False, new=[]): if identifiers and "{{ identifier }}" in description: if type_ == "variable": @@ -638,8 +638,11 @@ class CommonFormatter: if "description" in modified_attributes: name, previous, new = modified_attributes["description"] if previous: + identifiers = modified_attributes.get("identifiers", []) + if not identifiers: + identifiers = informations.get("identifiers") modified_description = _get_description( - previous[0], modified_attributes.get("identifiers", []), delete=True + previous[0], identifiers, delete=True ) else: modified_description = None diff --git a/tests/changelog/40_dynamic_variable_description_mod/after/rougail/00-base.yml b/tests/changelog/40_dynamic_variable_description_mod/after/rougail/00-base.yml index 295de6f56..9d97de1f2 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/after/rougail/00-base.yml +++ b/tests/changelog/40_dynamic_variable_description_mod/after/rougail/00-base.yml @@ -10,5 +10,6 @@ var: # A suffix variable description: A dynamic family dynamic: variable: _.var + var: # A dynamic variable ... diff --git a/tests/changelog/40_dynamic_variable_description_mod/before/rougail/00-base.yml b/tests/changelog/40_dynamic_variable_description_mod/before/rougail/00-base.yml index 3001ba971..76a554c68 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/before/rougail/00-base.yml +++ b/tests/changelog/40_dynamic_variable_description_mod/before/rougail/00-base.yml @@ -10,5 +10,6 @@ var: # A suffix variable description: A dynamic family {{ identifier }} dynamic: variable: _.var + var: # A dynamic variable {{ identifier }} ... diff --git a/tests/changelog/40_dynamic_variable_description_mod/result.adoc b/tests/changelog/40_dynamic_variable_description_mod/result.adoc index 1252b20a2..8a5f3aa41 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/result.adoc +++ b/tests/changelog/40_dynamic_variable_description_mod/result.adoc @@ -5,7 +5,7 @@ | Variable | Description | **dyn__val1__.var** + **dyn__val2__.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +++A dynamic variable {{ identifier }}.+++ + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +++A dynamic variable __val1__ or __val2__.+++ + #A dynamic variable.# |==== diff --git a/tests/changelog/40_dynamic_variable_description_mod/result.gitlab.md b/tests/changelog/40_dynamic_variable_description_mod/result.gitlab.md index b71c48128..285540290 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/result.gitlab.md +++ b/tests/changelog/40_dynamic_variable_description_mod/result.gitlab.md @@ -2,7 +2,7 @@ | Variable | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| -| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable {{ identifier }}.~~
A dynamic variable. | +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable *val1* or *val2*.~~
A dynamic variable. | diff --git a/tests/changelog/40_dynamic_variable_description_mod/result.html b/tests/changelog/40_dynamic_variable_description_mod/result.html index 33bf946fd..414b1d75e 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/result.html +++ b/tests/changelog/40_dynamic_variable_description_mod/result.html @@ -2,10 +2,10 @@ - + - +
Variable Description
Variable Description
dynval1.var
dynval2.var
string basic mandatory
A dynamic variable {{ identifier }}.
A dynamic variable.
dynval1.var
dynval2.var
string basic mandatory
A dynamic variable val1 or val2.
A dynamic variable.
diff --git a/tests/changelog/40_dynamic_variable_description_mod/result.md b/tests/changelog/40_dynamic_variable_description_mod/result.md index 343750db3..dc80de4a6 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/result.md +++ b/tests/changelog/40_dynamic_variable_description_mod/result.md @@ -2,5 +2,5 @@ | Variable | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| -| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable {{ identifier }}.~~
A dynamic variable. | +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable *val1* or *val2*.~~
A dynamic variable. | diff --git a/tests/changelog/40_dynamic_variable_description_mod/result.sh b/tests/changelog/40_dynamic_variable_description_mod/result.sh index cc92398d5..a41a1c6b6 100644 --- a/tests/changelog/40_dynamic_variable_description_mod/result.sh +++ b/tests/changelog/40_dynamic_variable_description_mod/result.sh @@ -3,7 +3,7 @@ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Variable  ┃ Description  ┃ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ -│ dynval1.var │ A dynamic variable {{ identifier }}. │ +│ dynval1.var │ A dynamic variable val1 or val2. │ │ dynval2.var │ A dynamic variable. │ │  string   basic   mandatory  │ │ └───────────────────────────────────────┴──────────────────────────────────────┘