From 39b035a1230af02dde737f8abc1e0c280adb2686 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Casaj=C3=BAs?= <adria.casajus@proton.ch>
Date: Thu, 12 May 2022 18:36:12 +0200
Subject: [PATCH] Added docs

---
 app/dashboard/views/alias_contact_manager.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/app/dashboard/views/alias_contact_manager.py b/app/dashboard/views/alias_contact_manager.py
index f5c560ca..8f755292 100644
--- a/app/dashboard/views/alias_contact_manager.py
+++ b/app/dashboard/views/alias_contact_manager.py
@@ -51,6 +51,13 @@ def email_validator():
 
 
 def create_contact(user: User, alias: Alias, contact_address: str) -> Contact:
+    """
+    Create a contact for a user. Can be restricted for new free users by enabling DISABLE_CREATE_CONTACTS_FOR_FREE_USERS.
+    Can throw exceptions:
+     - ErrAddressInvalid
+     - ErrContactAlreadyExists
+     - ErrContactUpgradeNeeded - If DISABLE_CREATE_CONTACTS_FOR_FREE_USERS this exception will be raised for new free users
+    """
     if not contact_address:
         raise ErrAddressInvalid("Empty address")
     try: