Comment and XML doc tweaks

SteveSandersonMS · SteveSandersonMS · commit 78e583d0fb39 · 2018-01-24T17:00:59.000-08:00
diff --git a/src/Microsoft.AspNetCore.SpaServices/Webpack/WebpackDevMiddlewareOptions.cs b/src/Microsoft.AspNetCore.SpaServices/Webpack/WebpackDevMiddlewareOptions.cs
@@ -52,7 +52,9 @@ public class WebpackDevMiddlewareOptions
         public IDictionary<string, string> EnvironmentVariables { get; set; }
 
         /// <summary>
-        /// Pass in the env parameter to webpack.
+        /// Specifies a value for the "env" parameter to be passed into the Webpack configuration
+        /// function. The value must be JSON-serializable, and will only be used if the Webpack
+        /// configuration is exported as a function.
         /// </summary>
         public object EnvParam { get; set; }
     }
diff --git a/src/Microsoft.AspNetCore.SpaServices/npm/aspnet-webpack/src/WebpackDevMiddleware.ts b/src/Microsoft.AspNetCore.SpaServices/npm/aspnet-webpack/src/WebpackDevMiddleware.ts
@@ -244,11 +244,11 @@ export function createWebpackDevServer(callback: CreateDevServerCallback, option
         : (webpackConfigModuleExports as WebpackConfigExport);
 
     if (webpackConfigExport instanceof Function) {
-        // If you export a function, we'll call it with an undefined 'env' arg, since we have nothing else
-        // to pass. This is the same as what the webpack CLI tool does if you specify no '--env.x' values.
-        // In the future, we could add support for configuring the 'env' param in Startup.cs. But right
-        // now, it's not clear that people will want to do that (and they can always make up their own
-        // default env values in their webpack.config.js).
+        // If you export a function, then Webpack convention is that it takes zero or one param,
+        // and that param is called `env` and reflects the `--env.*` args you can specify on
+        // the command line (e.g., `--env.prod`).
+        // When invoking it via WebpackDevMiddleware, we let you configure the `env` param in
+        // your Startup.cs.
         webpackConfigExport = webpackConfigExport(options.suppliedOptions.EnvParam);
     }
     const webpackConfigArray = webpackConfigExport instanceof Array ? webpackConfigExport : [webpackConfigExport];
