document drop fetch response

Close #47
MarketSquare · Dec 1, 2021 · 8241979 · 8241979
1 parent 606b01f
commit 8241979
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/CamundaLibrary/CamundaLibrary.py b/CamundaLibrary/CamundaLibrary.py
@@ -410,8 +410,17 @@ def get_fetch_response(self):
             return self.FETCH_RESPONSE.to_dict()
         return self.FETCH_RESPONSE
 
-    @keyword("Drop fetch response", tags=['task'])
+    @keyword("Drop fetch response", tags=['task', 'deprecated'])
     def drop_fetch_response(self):
+        """
+        Removes last process instance from cache.
+
+        *DEPRECATED*
+
+        Actually this keyword does not seem to make sense. Do you have a use case for this? Then contact the project on
+        GitHub, otherwise the keyword will be removed.
+        """
+        logger.warn('DEPRECATED. If you happen to have a use case for this keyword, save the keyword from deletion by contacting the project on GitHub:\thttps://github.com/MarketSquare/robotframework-camunda/issues>')
         self.FETCH_RESPONSE = {}
 
     @keyword("Throw BPMN Error", tags=['task'])