refactor: improve JSDoc examples with robust error handling

Author: Amansingh0807

lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js

@@ -25,62 +25,63 @@
 *
 * @example
 * var join = require( 'path' ).join;
-* var readFile = require( '@stdlib/fs/read-file' ).sync;
 * var writeFile = require( '@stdlib/fs/write-file' ).sync;
 * var unlink = require( '@stdlib/fs/unlink' ).sync;
+* var tmpdir = require( '@stdlib/os/tmpdir' );
 * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' );
 *
-* // Create a temporary file:
-* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' );
-* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' );
-* var err = writeFile( tmp, readFile( src ) );
+* // Create a temporary file in the system temp directory:
+* var tmp = join( tmpdir(), 'example_file.js' );
+* var content = '\'use strict\';\n\nvar x = 3.14;\n';
+* var err = writeFile( tmp, content );
 * if ( err ) {
 *     throw err;
 * }
 *
-* var files = [
-*     tmp
-* ];
-*
+* var files = [ tmp ];
 * var header = '// This file is licensed under Apache-2.0.';
 *
 * insertHeader( files, header, done );
 *
 * function done( error ) {
+*     // Always clean up the temporary file:
+*     var unlinkErr = unlink( tmp );
 *     if ( error ) {
 *         throw error;
 *     }
-*     // Remove the temporary file:
-*     unlink( tmp );
+*     if ( unlinkErr ) {
+*         throw unlinkErr;
+*     }
 * }
 *
 * @example
 * var join = require( 'path' ).join;
-* var readFile = require( '@stdlib/fs/read-file' ).sync;
 * var writeFile = require( '@stdlib/fs/write-file' ).sync;
 * var unlink = require( '@stdlib/fs/unlink' ).sync;
+* var tmpdir = require( '@stdlib/os/tmpdir' );
 * var insertHeader = require( '@stdlib/_tools/licenses/insert-header-file-list' );
 *
-* // Create a temporary file:
-* var src = join( __dirname, 'examples', 'fixtures', 'file.js.txt' );
-* var tmp = join( __dirname, 'examples', 'fixtures', 'tmp.js.txt' );
-* var err = writeFile( tmp, readFile( src ) );
+* // Create a temporary file in the system temp directory:
+* var tmp = join( tmpdir(), 'example_file.js' );
+* var content = '\'use strict\';\n\nvar x = 3.14;\n';
+* var err = writeFile( tmp, content );
 * if ( err ) {
 *     throw err;
 * }
 *
-* var files = [
-*     tmp
-* ];
-*
+* var files = [ tmp ];
 * var header = '// This file is licensed under Apache-2.0.';
 *
 * err = insertHeader.sync( files, header );
+*
+* // Always clean up the temporary file:
+* var unlinkErr = unlink( tmp );
 * if ( err instanceof Error ) {
 *     throw err;
 * }
-* // Remove the temporary file:
-* unlink( tmp );
+* if ( unlinkErr ) {
+*     throw unlinkErr;
+* }
 */
 
 // MODULES //