From 3cf32aec261accc1337a4aeb5768e182e61dfed7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Lebleu?= <jerome@maroufle.fr>
Date: Mon, 30 Nov 2015 19:03:11 +0100
Subject: [PATCH] [doc] Improve usage and add examples for user helpers

---
 data/apps/helpers.d/user | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/data/apps/helpers.d/user b/data/apps/helpers.d/user
index 69f96e0cf..fc58d0027 100644
--- a/data/apps/helpers.d/user
+++ b/data/apps/helpers.d/user
@@ -1,6 +1,9 @@
 # Check if a user exists
 #
+# example: ynh_user_exists 'toto' || exit 1
+#
 # usage: ynh_user_exists username
+# | arg: username - the username to check
 # | ret: retcode - 0 if user exists, 1 otherwise
 ynh_user_exists() {
     sudo yunohost user list --output-as json | grep -q "\"username\": \"${1}\""
@@ -8,7 +11,11 @@ ynh_user_exists() {
 
 # Retrieve a user information
 #
-# usage: ynh_user_info username key
+# example: mail=$(ynh_user_get_info 'toto' 'mail')
+#
+# usage: ynh_user_get_info username key
+# | arg: username - the username to retrieve info from
+# | arg: key - the key to retrieve
 # | ret: string - the key's value
 ynh_user_get_info() {
     sudo yunohost user info "${1}" --output-as plain | ynh_get_plain_key "${2}"