From 5aabf6350a28a57896f6ad67579692b21f6db6b0 Mon Sep 17 00:00:00 2001
From: Vanilagy <1696106+Vanilagy@users.noreply.github.com>
Date: Thu, 6 Nov 2025 16:31:02 +0100
Subject: [PATCH] Clarify docs

---
 src/packet.ts | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/packet.ts b/src/packet.ts
index c71890c..f5de60e 100644
--- a/src/packet.ts
+++ b/src/packet.ts
@@ -126,7 +126,10 @@ export class EncodedPacket {
 		}
 	}
 
-	/** If this packet is a metadata-only packet. Metadata-only packets don't contain their packet data. */
+	/**
+	 * If this packet is a metadata-only packet. Metadata-only packets don't contain their packet data. They are the
+	 * result of retrieving packets with {@link PacketRetrievalOptions.metadataOnly} set to `true`.
+	 */
 	get isMetadataOnly() {
 		return this.data === PLACEHOLDER_DATA;
 	}