From d7fc5d31ec53b67bbcc97da06f210e479e6b6e2c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= <felix@piedallu.me>
Date: Wed, 3 Mar 2021 10:59:29 +0100
Subject: [PATCH] helper doc fixes : string

---
 data/helpers.d/string | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/data/helpers.d/string b/data/helpers.d/string
index a0bcdbfaf..7036b3b3c 100644
--- a/data/helpers.d/string
+++ b/data/helpers.d/string
@@ -2,12 +2,12 @@
 
 # Generate a random string
 #
-# example: pwd=$(ynh_string_random --length=8)
-#
 # usage: ynh_string_random [--length=string_length]
 # | arg: -l, --length=  - the string length to generate (default: 24)
 # | ret: the generated string
 #
+# example: pwd=$(ynh_string_random --length=8)
+#
 # Requires YunoHost version 2.2.4 or higher.
 ynh_string_random() {
     # Declare an array to define the options of this helper.
@@ -30,9 +30,8 @@ ynh_string_random() {
 # | arg: -r, --replace_string=  - String that will replace matches
 # | arg: -f, --target_file=     - File in which the string will be replaced.
 #
-# As this helper is based on sed command, regular expressions and
-# references to sub-expressions can be used
-# (see sed manual page for more information)
+# As this helper is based on sed command, regular expressions and references to
+# sub-expressions can be used (see sed manual page for more information)
 #
 # Requires YunoHost version 2.6.4 or higher.
 ynh_replace_string () {
@@ -86,14 +85,15 @@ ynh_replace_special_string () {
 }
 
 # Sanitize a string intended to be the name of a database
-# (More specifically : replace - and . by _)
-#
-# example: dbname=$(ynh_sanitize_dbid $app)
 #
 # usage: ynh_sanitize_dbid --db_name=name
 # | arg: -n, --db_name=     - name to correct/sanitize
 # | ret: the corrected name
 #
+# example: dbname=$(ynh_sanitize_dbid $app)
+#
+# Underscorify the string (replace - and . by _)
+#
 # Requires YunoHost version 2.2.4 or higher.
 ynh_sanitize_dbid () {
     # Declare an array to define the options of this helper.