improve formatting of documentation

This commit is contained in:
Mira Weller
2025-01-13 13:12:52 +01:00
parent e2ae0b6780
commit 0c41dcb2ed
2 changed files with 16 additions and 14 deletions
+3 -3
View File
@@ -117,12 +117,12 @@ class LogEntryType:
def get_object_link_info(self, logentry) -> dict:
"""
Return information to generate a link to the content_object of a given logentry.
Return information to generate a link to the `content_object` of a given log entry.
Not implemented in the base class, causing the object link to be omitted.
:return: `dict` with the keys `href` (containing a URL to view/edit the object) and `val` (containing the
escaped text for the anchor element)
:return: Dictionary with the keys ``href`` (containing a URL to view/edit the object) and ``val`` (containing the
escaped text for the anchor element)
"""
pass