Add documentation

move-coop · Sep 7, 2023 · 9cca36c · 9cca36c
1 parent 84d10dc
commit 9cca36c
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/parsons/action_kit/action_kit.py b/parsons/action_kit/action_kit.py
@@ -235,7 +235,9 @@ def update_event(self, event_id, **kwargs):
 
     def get_blackholed_email(self, email):
         """
-        Get a blackholed email.
+        Get a blackholed email. A blackholed email is an email that has been prevented from
+        receiving bulk and transactional emails from ActionKit. `Documentation <https://\
+        docs.actionkit.com/docs/manual/guide/mailings_tools.html#blackhole>`_.
 
         `Args:`
             email: str
@@ -249,7 +251,9 @@ def get_blackholed_email(self, email):
 
     def blackhole_email(self, email):
         """
-        Blackhole an email.
+        Prevent an email from receiving bulk and transactional emails from ActionKit.
+        `Documentation <https://docs.actionkit.com/docs/manual/guide/\
+        mailings_tools.html#blackhole>`_.
 
         `Args:`
             user_id: str