Skip to content

Commit 9fa4a2d

Browse files
committed
document drop fetch response
Close #75
1 parent 83eb807 commit 9fa4a2d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CamundaLibrary/CamundaLibrary.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -410,17 +410,17 @@ def get_fetch_response(self):
410410
return self.FETCH_RESPONSE.to_dict()
411411
return self.FETCH_RESPONSE
412412

413-
@keyword("Drop fetch response", tags=['task', 'deprecated'])
413+
@keyword("Drop fetch response", tags=['task'])
414414
def drop_fetch_response(self):
415415
"""
416416
Removes last process instance from cache.
417417
418-
*DEPRECATED*
418+
When you use common keywords like `complete task` or `unlock` or any other keyword finishing execution of a task,
419+
you do not need to call this keyword, as it is called implicitly.
419420
420-
Actually this keyword does not seem to make sense. Do you have a use case for this? Then contact the project on
421-
GitHub, otherwise the keyword will be removed.
421+
This keyword is handy, when you mix CamundaLibrary keywords and custom REST calls to Camunda API. In such
422+
scenarios you might want to empty the cache.
422423
"""
423-
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>')
424424
self.FETCH_RESPONSE = {}
425425

426426
@keyword("Throw BPMN Error", tags=['task'])

0 commit comments

Comments
 (0)