update RecogHandler.get docstring

This commit is contained in:
InspectorCaracal 2022-04-25 11:52:13 -06:00 committed by GitHub
parent e86b81917b
commit 97b83ef241

View file

@ -773,13 +773,13 @@ class RecogHandler:
def get(self, obj):
"""
Get recog replacement string, if one exists, otherwise
get sdesc and as a last resort, the object's key.
Get recog replacement string, if one exists.
Args:
obj (Object): The object, whose sdesc to replace
Returns:
recog (str): The replacement string to use.
recog (str or None): The replacement string to use, or
None if there is no recog for this object.
Notes:
This method will respect a "enable_recog" lock set on