From 4b0d788149148e8a700843ae54e59671f2a1ebfe Mon Sep 17 00:00:00 2001
From: aviau <alexandre@alexandreviau.net>
Date: Sat, 16 Jan 2021 21:57:25 -0500
Subject: [PATCH] index: small docs improvements

- Document that we use an '|indexed' suffix in the 'have:' key to mark
  indexed blobs.

- Don't refer to GetOwnerClaims. This method no longer exists and was
  replaced by AppendClaims. Don't bother naming the exact Index
  interface method this key serves but instead focus on explaining what
  information we store in that key.
---
 pkg/index/doc.go | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/pkg/index/doc.go b/pkg/index/doc.go
index 453e91fe3..f0d53c438 100644
--- a/pkg/index/doc.go
+++ b/pkg/index/doc.go
@@ -37,9 +37,9 @@ for search operations:
 
  * Other:
    "meta:<blobref>" -> "<size>|<mimetype>"
-   "have:<blobref>" -> "<size>" (used for enumeration, which doesn't need mime type)
+   "have:<blobref>" -> "<size>" or "<size>|indexed" (used for enumeration, which doesn't need mime type and for marking indexed blobs)
 
- * For GetOwnerClaims(permanode, signer):
+ * Permanode Claims:
    "claim|<permanode-blobref>|<keyid>|<date>|<claim-blobref>" -> "<URL:type>|<URL:attr>|<URL:value>"
 
 */