Merge pull request microsoft#851 from Microsoft/pgonzal/fix-rush-init-typo

pgonzal · web-flow · commit ea79bda60535 · 2018-09-28T14:41:15.000-07:00
[rush] Fix an incorrect default in the "rush init" template
diff --git a/apps/rush-lib/assets/rush-init/rush.json b/apps/rush-lib/assets/rush-init/rush.json
@@ -61,9 +61,12 @@
 
   /**
    * If you would like the version specifiers for your dependencies to be consistent, then
-   * uncomment this line. Note this is effectively like running "rush check" before the following:
+   * uncomment this line. This is effectively similar to running "rush check" before any
+   * of the following commands:
+   *
    *   rush install, rush update, rush link, rush version, rush publish
-   * In some cases you may want this turned on, but need to allow some packages to use a different
+   *
+   * In some cases you may want this turned on, but need to allow certain packages to use a different
    * version. In those cases, you will need to add an entry to the "allowedAlternateVersions"
    * section of the common-versions.json.
    */
@@ -87,7 +90,7 @@
    * that brings people together, and maybe also identifies poor coding practices (e.g. file
    * references that reach into other project's folders without using NodeJS module resolution).
    *
-   * The defaults are projectFolderMinDepth=2 and projectFolderMaxDepth=2.
+   * The defaults are projectFolderMinDepth=1 and projectFolderMaxDepth=2.
    *
    * To remove these restrictions, you could set projectFolderMinDepth=1
    * and set projectFolderMaxDepth to a large number.
diff --git a/common/changes/@microsoft/rush/pgonzal-fix-rush-init-typo_2018-09-28-21-33.json b/common/changes/@microsoft/rush/pgonzal-fix-rush-init-typo_2018-09-28-21-33.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix an incorrect default in the \"rush init\" template comments",
+      "packageName": "@microsoft/rush",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "pgonzal@users.noreply.github.com"
+}
