Add comments for spacing

Signed-off-by: Huy Nguyen <73027756+huyaboo@users.noreply.github.com>

src/core/server/saved_objects/import/utils.ts

@@ -6,6 +6,13 @@
 import { parse, stringify } from 'hjson';
 import { SavedObject, SavedObjectsClientContract } from '../types';
 
+/**
+ * Given a Vega spec, the new datasource (by name), and spacing,
+ *
+ * @param {string} spec - the stringified Vega spec (HJSON or JSON)
+ * @param {string} newDataSourceName - the datasource name to append
+ * @param {number} [spacing=2] - how large the indenting should be after updating the spec (should be set to > 0 for a readable spec)
+ */
 export interface UpdateDataSourceNameInVegaSpecProps {
   spec: string;
   newDataSourceName: string;

src/plugins/home/server/services/sample_data/data_sets/util.ts

@@ -86,6 +86,7 @@ export const getSavedObjectsWithDataSource = (
             const updatedVegaSpec = updateDataSourceNameInVegaSpec({
               spec: vegaSpec,
               newDataSourceName: dataSourceTitle,
+              // Spacing of 1 prevents the Sankey visualization in logs data from exceeding the default url length and breaking
               spacing: 1,
             });