Add note clarifying a confusing method call

The call is made via user-supplied string, so a code search
will not find where the method is used.
Adding a note to help prevent future confusion.

Change-Id: Ib1fc34d0cc9ca5ee54111c8ffe43db30c8a48d96
This commit is contained in:
Eric K 2018-12-08 08:32:34 -08:00
parent 112d5eaf26
commit e9cccb4f07
1 changed files with 3 additions and 0 deletions

View File

@ -179,6 +179,9 @@ class PolicyModel(base.APIModel):
value = params[key]
return value.lower() == "true" or value == "1"
# Note: It's confusing to figure out how this method is called.
# It is called via user supplied string in the `action` method of
# api/webservice.py:ElementHandler
# Note(thread-safety): blocking function
def simulate_action(self, params, context=None, request=None):
"""Simulate the effects of executing a sequence of updates.