From 14cda865742824b04a8119d83df6fc88739cc3b8 Mon Sep 17 00:00:00 2001
From: Joshua Chudy <jchudy@isi.edu>
Date: Wed, 20 Mar 2024 11:12:56 -0700
Subject: [PATCH] comment for metadata function

---
 js/hatrac.js | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/js/hatrac.js b/js/hatrac.js
index dd12d5a3..d4c0709e 100644
--- a/js/hatrac.js
+++ b/js/hatrac.js
@@ -543,6 +543,12 @@ var ERMrest = (function(module) {
         return deferred.promise;
     };
 
+    /**
+     * @desc Call this function to create an update metadata request for updating the content-disposition
+     *
+     * @returns {Promise} A promise resolved with no value or the url if it already exists
+     * or rejected with error
+     */
     upload.prototype.createUpdateMetadataJob = function (contextHeaderParams) {
         var self = this;
         this.erred = false;