stove/rougail-output-doc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

fix: do not display {{ identifier }} in description

Browse source
This commit is contained in:
egarette@silique.fr 2026-03-30 22:28:05 +02:00
parent f9d3428bf3
commit d26653d95c
8 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/rougail/output_doc/utils.py
View file

@ -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

1
tests/changelog/40_dynamic_variable_description_mod/after/rougail/00-base.yml
View file

@ -10,5 +10,6 @@ var: # A suffix variable
description: A dynamic family
dynamic:
variable: _.var
var: # A dynamic variable
...

1
tests/changelog/40_dynamic_variable_description_mod/before/rougail/00-base.yml
View file

@ -10,5 +10,6 @@ var: # A suffix variable
description: A dynamic family {{ identifier }}
dynamic:
variable: _.var
var: # A dynamic variable {{ identifier }}
...

2
tests/changelog/40_dynamic_variable_description_mod/result.adoc
View file

@ -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.#
|====

2
tests/changelog/40_dynamic_variable_description_mod/result.gitlab.md
View file

@ -2,7 +2,7 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| **<a id="dyn:::identifier:::.var" name="dyn:::identifier:::.var">dyn*val1*.var</a>**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable {{ identifier }}.~~<br/><ins>A dynamic variable.</ins> |
| **<a id="dyn:::identifier:::.var" name="dyn:::identifier:::.var">dyn*val1*.var</a>**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable *val1* or *val2*.~~<br/><ins>A dynamic variable.</ins> |
</details>

4
tests/changelog/40_dynamic_variable_description_mod/result.html
View file

@ -2,10 +2,10 @@
<table>
<thead>
<tr><th>Variable </th><th>Description </th></tr>
<tr><th>Variable </th><th>Description </th></tr>
</thead>
<tbody>
<tr><td><b>dyn<i>val1</i>.var</b><br/><b>dyn<i>val2</i>.var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td><del>A dynamic variable {{ identifier }}.</del><br/><ins>A dynamic variable.</ins></td></tr>
<tr><td><b>dyn<i>val1</i>.var</b><br/><b>dyn<i>val2</i>.var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td><del>A dynamic variable <i>val1</i> or <i>val2</i>.</del><br/><ins>A dynamic variable.</ins></td></tr>
</tbody>
</table>

2
tests/changelog/40_dynamic_variable_description_mod/result.md
View file

@ -2,5 +2,5 @@
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| **<a id="dyn:::identifier:::.var" name="dyn:::identifier:::.var">dyn*val1*.var</a>**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable {{ identifier }}.~~<br/><ins>A dynamic variable.</ins> |
| **<a id="dyn:::identifier:::.var" name="dyn:::identifier:::.var">dyn*val1*.var</a>**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | ~~A dynamic variable *val1* or *val2*.~~<br/><ins>A dynamic variable.</ins> |

2
tests/changelog/40_dynamic_variable_description_mod/result.sh
View file

@ -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  │ │
└───────────────────────────────────────┴──────────────────────────────────────┘