refined the doc comment

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
oras-project · Nov 14, 2023 · dd0b9a8 · dd0b9a8
1 parent 410068d
commit dd0b9a8
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/content/oci/oci.go b/content/oci/oci.go
@@ -44,8 +44,10 @@ import (
 type Store struct {
 	// AutoSaveIndex controls if the OCI store will automatically save the index
 	// file when needed.
-	//   - If AutoSaveIndex is set to true, the OCI store will automatically save the
-	//     changes to `index.json` on Tag() and Delete() calls, and when pushing a manifest.
+	//   - If AutoSaveIndex is set to true, the OCI store will automatically save
+	//     the changes to `index.json` when
+	//      1. pushing a manifest
+	//      2. calling Tag() or Delete()
 	//   - If AutoSaveIndex is set to false, it's the caller's responsibility
 	//     to manually call SaveIndex() when needed.
 	//   - Default value: true.