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

Add examples to doc string of get_numbered_name()

Browse source
This commit is contained in:
Chiizujin 2024-04-01 23:05:25 +11:00
parent f4cb272e22
commit 8da1e3790f
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
evennia/objects/objects.py
View file

@ -1483,8 +1483,12 @@ class DefaultObject(ObjectDB, metaclass=TypeclassBase):
including the count. including the count.
Examples: Examples:
:: ::
obj.get_numbered_name(3, looker, key="foo") -> ("a foo", "three foos") - obj.get_numbered_name(3, looker, key="foo") -> ("a foo", "three foos")
- obj.get_numbered_name(1, looker, key="Foobert", return_string=True)
-> "a Foobert"
- obj.get_numbered_name(1, looker, key="Foobert", return_string=True, no_article=True)
-> "Foobert"
""" """
plural_category = "plural_key" plural_category = "plural_key"