From d21e43bc5917eaf515e2d775d373b08677945d99 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rapha=C3=ABl=20Vinot?= <raphael@vinot.info>
Date: Wed, 20 Jan 2021 13:44:23 +0100
Subject: [PATCH] chg: Improve docstring for get_event

fix #686
---
 pymisp/api.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/pymisp/api.py b/pymisp/api.py
index a046af7..a386e0d 100644
--- a/pymisp/api.py
+++ b/pymisp/api.py
@@ -285,10 +285,12 @@ class PyMISP:
                   deleted: Union[bool, int, list] = False,
                   extended: Union[bool, int] = False,
                   pythonify: bool = False) -> Union[Dict, MISPEvent]:
-        """Get an event from a MISP instance
+        """Get an event from a MISP instance. Includes collections like
+        Attribute, EventReport, Feed, Galaxy, Object, Tag, etc. so the
+        response size may be large.
 
         :param event: event to get
-        :param deleted: whether to include deleted events
+        :param deleted: whether to include soft-deleted attributes
         :param extended: whether to get extended events
         :param pythonify: Returns a list of PyMISP Objects instead of the plain json output. Warning: it might use a lot of RAM
         """