Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify taghandler.get docstring

Browse source
This commit is contained in:
Griatch 2018-01-07 16:21:59 +01:00
parent 217bc27826
commit e8cffa62a6
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
evennia/typeclasses/tags.py
View file

@ -269,14 +269,15 @@ class TagHandler(object):
def get(self, key=None, default=None, category=None, return_tagobj=False, return_list=False): def get(self, key=None, default=None, category=None, return_tagobj=False, return_list=False):
""" """
Get the tag for the given key or list of tags. Get the tag for the given key, category or combination of the two.
Args: Args:
key (str or list): The tag or tags to retrieve. key (str or list, optional): The tag or tags to retrieve.
default (any, optional): The value to return in case of no match. default (any, optional): The value to return in case of no match.
category (str, optional): The Tag category to limit the category (str, optional): The Tag category to limit the
request to. Note that `None` is the valid, default request to. Note that `None` is the valid, default
category. category. If no `key` is given, all tags of this category will be
returned.
return_tagobj (bool, optional): Return the Tag object itself return_tagobj (bool, optional): Return the Tag object itself
instead of a string representation of the Tag. instead of a string representation of the Tag.
return_list (bool, optional): Always return a list, regardless return_list (bool, optional): Always return a list, regardless