From acff48ddab28314ac332bde69987e6eaf114e20b Mon Sep 17 00:00:00 2001
From: klabo <joelklabo@gmail.com>
Date: Mon, 21 Aug 2023 09:50:34 -0700
Subject: [PATCH] Add Warning in Documentation for `display_name`

Co-authored-by: Bryan Montz <bryanmontz@me.com>
---
 Sources/NostrSDK/Events/SetMetadataEvent.swift | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Sources/NostrSDK/Events/SetMetadataEvent.swift b/Sources/NostrSDK/Events/SetMetadataEvent.swift
index 05efe1d..67656f1 100644
--- a/Sources/NostrSDK/Events/SetMetadataEvent.swift
+++ b/Sources/NostrSDK/Events/SetMetadataEvent.swift
@@ -14,6 +14,7 @@ public struct UserMetadata: Codable {
     public let name: String?
     
     /// The user's display name.
+    /// > Warning: This property is not part of the Nostr specifications.
     public let displayName: String?
 
     /// The user's description of themself.