Add Warning in Documentation for display_name

Co-authored-by: Bryan Montz <[email protected]>
nostr-sdk · Aug 21, 2023 · acff48d · acff48d
1 parent 57e40e3
commit acff48d
Showing 1 changed file with 1 addition and 0 deletions.
diff --git 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.