added more info to comments

informatics-isi-edu · Oct 1, 2024 · c15b13b · c15b13b
1 parent 6e9f2bd
commit c15b13b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/js/column.js b/js/column.js
@@ -1666,7 +1666,7 @@ module._extends(ForeignKeyPseudoColumn, ReferenceColumn);
 /**
  * Given the available tuple data, generate the uniqueId for the selected row from the table this pseudo column points to
  *
- * @param {*} linkedData
+ * @param {Object} linkedData key-value pairs of column values of the table this pseudocolumn points to
  */
 ForeignKeyPseudoColumn.prototype.generateUniqueId = function (linkedData) {
     return module._generateTupleUniqueId(this.reference.table.shortestKey, linkedData);

diff --git a/js/utils/helpers.js b/js/utils/helpers.js
@@ -1026,6 +1026,13 @@
         };
     };
 
+    /**
+     * Given the available linked data, generate the uniqueId for the row this data represents given the shortest key of the table
+     *
+     * @param {ERMrest.Key[]} tableShortestKey shortest key from the table the linkedData is for
+     * @param {Object} linkedData data to use to generate the unique id
+     * @returns string | null - unique id for the row the linkedData represents
+     */
     module._generateTupleUniqueId = function (tableShortestKey, linkedData) {
         var keyName, hasNull = false, _uniqueId = "";