Merge pull request #1952 from oleole39/fix_escaping_in_generate_helpe…

…rs_template Fix escaping in generate helpers doc template & v2.1 helpers comments
YunoHost · Sep 17, 2024 · b8c12f2 · b8c12f2
2 parents f14f5bb + 8f6fda8
commit b8c12f2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/doc/helper_doc_template.md b/doc/helper_doc_template.md
@@ -21,7 +21,7 @@ Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/{{
         {% for h in helpers %}
 #### {{ h.name }}
 
-[details summary="<i>{{ h.brief }}</i>" class="helper-card-subtitle text-muted"]
+[details summary="<i>{{ h.brief | escape }}</i>" class="helper-card-subtitle text-muted"]
 
 **Usage**: `{{ h.usage }}`
 {%- if h.args %}

diff --git a/helpers/helpers.v2.1.d/logging b/helpers/helpers.v2.1.d/logging
@@ -56,8 +56,7 @@ ynh_exec_and_print_stderr_only_if_error() {
     fi
 }
 
-# Return data to the YunoHost core for later processing
-# (to be used by special hooks like app config panel and core diagnosis)
+# Return data to the YunoHost core for later processing (to be used by special hooks like app config panel and core diagnosis)
 #
 # usage: ynh_return somedata
 ynh_return() {

diff --git a/helpers/helpers.v2.1.d/setting b/helpers/helpers.v2.1.d/setting
@@ -44,11 +44,13 @@ ynh_app_setting_set() {
 #
 # Hence it's meant as a replacement for this legacy overly complex syntax:
 #
+# ```
 # if [ -z "${foo:-}" ]
 # then
 #     foo="bar"
 #     ynh_app_setting_set --key="foo" --value="$foo"
 # fi
+# ```
 #
 # usage: ynh_app_setting_set_default --key=key --value=value
 # | arg: --app=     - the application id (global $app by default)