Slight rephrasing of a docstring.

This commit is contained in:
Griatch 2016-09-20 16:30:23 +02:00
parent d88d882439
commit 47fa88e0fc

View file

@ -545,9 +545,11 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
from_obj (Object, optional): An object designated as the from_obj (Object, optional): An object designated as the
"sender" of the message. See `DefaultObject.msg()` for "sender" of the message. See `DefaultObject.msg()` for
more info. more info.
mapping (dict, optional): A dictionary of token-object mapping (dict, optional): A mapping of formatting keys
pairs allowng display name substitution. See Notes `{"key":<object>, "key2":<object2>,...}. The keys
must match `{key}` markers in `message` and will be
replaced by the return of `<object>.get_display_name(looker)`
for every looker that is messaged.
Kwargs: Kwargs:
Keyword arguments will be passed on to `obj.msg()` for all Keyword arguments will be passed on to `obj.msg()` for all
messaged objects. messaged objects.
@ -560,7 +562,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
the room before substitution. the room before substitution.
Example: Example:
Say char is a Character object and npc is an NPC object. Say char is a Character object and npc is an NPC object:
char.location.msg_contents( char.location.msg_contents(
"{attacker} attacks {defender}", "{attacker} attacks {defender}",