docs: clarify AuditLogAction.overwrite_create (#1227)

Snipy7374 · web-flow · commit 050220b1a10d · 2024-08-13T17:43:15.000Z
diff --git a/changelog/1180.doc.rst b/changelog/1180.doc.rst
@@ -0,0 +1 @@
+Adding some clarifying documentation around the type of :attr:`AuditLogEntry.extra` when the action is :attr:`~AuditLogAction.overwrite_create`.
diff --git a/docs/api/audit_logs.rst b/docs/api/audit_logs.rst
@@ -861,9 +861,8 @@ AuditLogAction
 
         When this is the action, the type of :attr:`~AuditLogEntry.extra` is
         either a :class:`Role` or :class:`Member`. If the object is not found
-        then it is a :class:`Object` with an ID being filled, a name, and a
-        ``type`` attribute set to either ``'role'`` or ``'member'`` to help
-        dictate what type of ID it is.
+        then it is a :class:`Object` with an ID being filled, additionally if the object
+        refers to a role then the :class:`Object` has also a ``name`` attribute.
 
         Possible attributes for :class:`AuditLogDiff`:
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Adding some clarifying documentation around the type of :attr:`AuditLogEntry.extra` when the action is :attr:`~AuditLogAction.overwrite_create`.