From b43d7d3a2bc68be052e1d9f094cf36b458a66944 Mon Sep 17 00:00:00 2001
From: joshemb <josh@elixxir.io>
Date: Thu, 28 Jul 2022 12:56:39 -0700
Subject: [PATCH] Improve NewCmixFromBackup docstring
---
bindings/backup.go | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/bindings/backup.go b/bindings/backup.go
index 367c70292..b282df56d 100644
--- a/bindings/backup.go
+++ b/bindings/backup.go
@@ -32,12 +32,13 @@ type UpdateBackupFunc interface {
////////////////////////////////////////////////////////////////////////////////
// NewCmixFromBackup initializes a new e2e storage from an encrypted
-// backup.
+// backup. Users of this function should delete the storage directory on error.
+// Users of this function should call LoadCmix as normal once this call succeeds.
//
// Params
// - ndfJSON - JSON of the NDF.
// - storageDir - directory for the storage files.
-// - sessionPassword - password used in LoadCmix.
+// - sessionPassword - password to decrypt the data in the storageDir.
// - backupPassphrase - backup passphrase provided by the user. Used to decrypt backup.
// - backupFileContents - the file contents of the backup.
//
--
GitLab