From 5972dc909e18358e591090a6bda6708c7791a671 Mon Sep 17 00:00:00 2001 From: InspectorCaracal <51038201+InspectorCaracal@users.noreply.github.com> Date: Mon, 18 Mar 2024 12:53:38 -0600 Subject: [PATCH] update get_display_name docstring --- evennia/objects/objects.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index ddbbc5269d..53f8798c4a 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -1431,19 +1431,15 @@ class DefaultObject(ObjectDB, metaclass=TypeclassBase): Displays the name of the object in a viewer-aware manner. Args: - looker (TypedObject): The object or account that is looking - at/getting inforamtion for this object. If not given, `.name` will be - returned, which can in turn be used to display colored data. + looker (TypedObject): The object or account that is looking at or getting information + for this object. Returns: - str: A name to display for this object. This can contain color codes and may - be customized based on `looker`. By default this contains the `.key` of the object, - followed by the DBREF if this user is privileged to control said object. + str: A name to display for this object. By default this returns the `.name` of the object. Notes: - This function could be extended to change how object names appear to users in character, - but be wary. This function does not change an object's keys or aliases when searching, - and is expected to produce something useful for builders. + This function can be extended to change how object names appear to users in character, + but it does not change an object's keys or aliases when searching. """ return self.name