From f9ef14e4399d1063a8ccb7def7ae4c70de6c40cc Mon Sep 17 00:00:00 2001
From: Julien Malik <julien.malik@paraiso.me>
Date: Mon, 12 Sep 2016 22:26:24 +0200
Subject: [PATCH] [doc] add documentation for private function

---
 src/yunohost/alias.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/yunohost/alias.py b/src/yunohost/alias.py
index 5c2db0b09..8f8221f65 100644
--- a/src/yunohost/alias.py
+++ b/src/yunohost/alias.py
@@ -177,6 +177,13 @@ def alias_info(auth, alias):
 
 
 def _ensure_ldap_ou_is_created(auth):
+    """
+    Make sure the 'ou=aliases' tree is created, for holding aliases entries.
+    Raises an exception in case of error.
+    
+    Keyword argument:
+        auth -- the auth object from moulinette, managing the LDAP connection
+    """
     rdn = 'ou=aliases'
     attr_dict = {
            'objectClass'   : ['organizationalUnit', 'top'],
@@ -184,5 +191,3 @@ def _ensure_ldap_ou_is_created(auth):
     if not auth.search('dc=yunohost,dc=org', rdn, attr_dict['objectClass']) :
         if auth.add(rdn, attr_dict):
             msignals.display(m18n.n('alias_init'), 'success')
-    return
-