📝 Add docstrings to bump-partials

compile-partial.js

@@ -13,6 +13,14 @@ if (fs.existsSync(helpersDir)) {
   });
 }
 
+/**
+ * Reads and parses a JSON file from the specified path.
+ *
+ * If the file cannot be read or parsed, returns an empty object.
+ *
+ * @param {string} filepath - Path to the JSON file.
+ * @returns {Object} The parsed JSON object, or an empty object if reading or parsing fails.
+ */
 function readJson(filepath) {
   try {
     return JSON.parse(fs.readFileSync(filepath, 'utf8'));

gulpfile.js

@@ -28,6 +28,13 @@ const glob = {
 const rapidocSrc = 'node_modules/rapidoc/dist/rapidoc-min.js'
 const rapidocDest = path.join(srcDir, 'static')
 
+/**
+ * Compiles Handlebars partial templates by executing a Node.js script for each specified partial.
+ *
+ * @param {Function} cb - Callback to signal task completion or failure.
+ *
+ * @throws {Error} If any partial compilation fails, the callback is invoked with an error.
+ */
 function compileWidgets (cb) {
   const partialsToCompile = [
     { name: 'header-content', context: 'context/header-content.json' },
@@ -50,6 +57,11 @@ function compileWidgets (cb) {
   }
 }
 
+/**
+ * Copies the Rapidoc JavaScript file from the source location to the static assets directory.
+ *
+ * @returns {Stream} A Gulp stream representing the copy operation.
+ */
 function copyRapidoc () {
   return gulp.src(rapidocSrc)
     .pipe(gulp.dest(rapidocDest))