More accurate documentation

btoms20 · btoms20 · commit 9f27ebc8072f · 2025-03-05T20:59:34.000-08:00
diff --git a/Sources/Multiaddr/Multiaddr.swift b/Sources/Multiaddr/Multiaddr.swift
@@ -111,7 +111,7 @@ public struct Multiaddr: Equatable {
         addresses.popLast()
     }
 
-    /// Extracts a PeerID from the Multiaddress if one exists, otherwise returns nil
+    /// Extracts a PeerID's String representation from the Multiaddress if one exists, otherwise returns nil
     public func getPeerIDString() -> String? {
         self.addresses.last(where: {
             ($0.addrProtocol == .p2p || $0.addrProtocol == .ipfs)

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ public struct Multiaddr: Equatable {`
`111`	`111`	`addresses.popLast()`
`112`	`112`	`}`
`113`	`113`
`114`		`- /// Extracts a PeerID from the Multiaddress if one exists, otherwise returns nil`
	`114`	`+ /// Extracts a PeerID's String representation from the Multiaddress if one exists, otherwise returns nil`
`115`	`115`	`public func getPeerIDString() -> String? {`
`116`	`116`	`self.addresses.last(where: {`
`117`	`117`	`($0.addrProtocol == .p2p \|\| $0.addrProtocol == .ipfs)`