From b2c0855d6d701bd80666e0693bd193dc69efb4a0 Mon Sep 17 00:00:00 2001
From: James Hu <51237606+jameshu111@users.noreply.github.com>
Date: Wed, 7 Jun 2023 12:45:08 -0400
Subject: Comments

---
 src/client/documents/Documents.ts | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

(limited to 'src/client/documents')

diff --git a/src/client/documents/Documents.ts b/src/client/documents/Documents.ts
index 0030af982..06b48fe96 100644
--- a/src/client/documents/Documents.ts
+++ b/src/client/documents/Documents.ts
@@ -1841,10 +1841,22 @@ export namespace DocUtils {
         });
     }
 
+    /**
+     * uploadFilesToDocs will take in an array of Files, and creates documents for the 
+     * new files. 
+     * 
+     * @param files an array of files that will be uploaded
+     * @param options options to use while uploading
+     * @returns 
+     */
     export async function uploadFilesToDocs(files: File[], options: DocumentOptions) {
         const generatedDocuments: Doc[] = [];
-        const fileNoGuidPairs: Networking.FileGuidPair[] = [];
-        files.map(file => fileNoGuidPairs.push({file}));
+
+        // UploadFilesToServer takes an array of FileGuidPairs,
+        // but these files do not have overwriteDocs, so
+        // we do not set guid, allowing the client to generate one. 
+        const fileNoGuidPairs: Networking.FileGuidPair[] = files.map(file => ({file}));
+
         const upfiles = await Networking.UploadFilesToServer(fileNoGuidPairs);
         for (const {
             source: { name, type },
@@ -1857,6 +1869,8 @@ export namespace DocUtils {
 
     export function uploadFileToDoc(file: File, options: DocumentOptions, overwriteDoc: Doc) {
         const generatedDocuments: Doc[] = [];
+        // Since this file has an overwriteDoc, we can set the client tracking guid
+        // to the overwriteDoc's guid. 
         Networking.UploadFilesToServer([{file, guid: overwriteDoc[Id]}]).then(upfiles => {
             const {
                 source: { name, type },
-- 
cgit v1.2.3-70-g09d2