From c09338f403e33293ee72d2e73d4377945d4d9969 Mon Sep 17 00:00:00 2001
From: Harry <109690906+harry-signal@users.noreply.github.com>
Date: Tue, 5 Mar 2024 09:51:13 -0800
Subject: [PATCH] Add a comment to message attachment captions

---
 .../V2/AttachmentReference/AttachmentReference+Owner.swift    | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/SignalServiceKit/src/Messages/Attachments/V2/AttachmentReference/AttachmentReference+Owner.swift b/SignalServiceKit/src/Messages/Attachments/V2/AttachmentReference/AttachmentReference+Owner.swift
index a73d10303a..e387212434 100644
--- a/SignalServiceKit/src/Messages/Attachments/V2/AttachmentReference/AttachmentReference+Owner.swift
+++ b/SignalServiceKit/src/Messages/Attachments/V2/AttachmentReference/AttachmentReference+Owner.swift
@@ -152,6 +152,10 @@ extension AttachmentReference {
         /// Caption on the attachment.
         /// Used for:
         /// * message body attachments
+        ///   * legacy only; the ability to set captions on message
+        ///     attachments was removed long ago. We maintain them
+        ///     for existing messages. New message attachments always
+        ///     inherit their "caption" from their parent message.
         /// * story media
         /// But even in those cases its optional.
         fileprivate let _caption: MessageBody?