From 9fa4a2dac6d35fd39bc19c3b06a11846c819f3cb Mon Sep 17 00:00:00 2001 From: noordsestern Date: Mon, 4 Apr 2022 23:05:07 +0200 Subject: [PATCH] document `drop fetch response` Close #75 --- CamundaLibrary/CamundaLibrary.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CamundaLibrary/CamundaLibrary.py b/CamundaLibrary/CamundaLibrary.py index 7973e3e..214fdbe 100644 --- a/CamundaLibrary/CamundaLibrary.py +++ b/CamundaLibrary/CamundaLibrary.py @@ -410,17 +410,17 @@ def get_fetch_response(self): return self.FETCH_RESPONSE.to_dict() return self.FETCH_RESPONSE - @keyword("Drop fetch response", tags=['task', 'deprecated']) + @keyword("Drop fetch response", tags=['task']) def drop_fetch_response(self): """ Removes last process instance from cache. - *DEPRECATED* + When you use common keywords like `complete task` or `unlock` or any other keyword finishing execution of a task, + you do not need to call this keyword, as it is called implicitly. - 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. + This keyword is handy, when you mix CamundaLibrary keywords and custom REST calls to Camunda API. In such + scenarios you might want to empty the cache. """ - 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'])