From bf130584a640daffec5fbe1526bb8d92fdea1eef Mon Sep 17 00:00:00 2001
From: Shannon <sdeminick@gmail.com>
Date: Mon, 12 Feb 2018 18:28:51 +1100
Subject: [PATCH] updates docs

---
 src/Umbraco.Core/Services/IAuditService.cs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/Umbraco.Core/Services/IAuditService.cs b/src/Umbraco.Core/Services/IAuditService.cs
index 4b803dc012..ffdbbcbe85 100644
--- a/src/Umbraco.Core/Services/IAuditService.cs
+++ b/src/Umbraco.Core/Services/IAuditService.cs
@@ -70,7 +70,11 @@ namespace Umbraco.Core.Services
         /// <param name="affectedUserId">The identifier of the user affected by the audited event.</param>
         /// <param name="affectedDetails">Free-form details about the entity affected by the audited event.</param>
         /// <param name="eventType">
-        /// The type of the audited event - must contain only alphanumeric chars, hyphens and at least one '/' defining categories
+        /// The type of the audited event - must contain only alphanumeric chars and hyphens with forward slashes separating categories.
+        /// <example>
+        /// The eventType will generally be formatted like: {application}/{entity-type}/{category}/{sub-category}
+        /// Example: umbraco/user/sign-in/failed
+        /// </example>
         /// </param>
         /// <param name="eventDetails">Free-form details about the audited event.</param>
         IAuditEntry Write(int performingUserId, string perfomingDetails, string performingIp, DateTime eventDate, int affectedUserId, string affectedDetails, string eventType, string eventDetails);