more docs rewording

google · Feb 4, 2024 · 5c852aa · 5c852aa
1 parent a080872
commit 5c852aa
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/docs/command-usage.md b/docs/command-usage.md
@@ -74,14 +74,14 @@ These flags will configure the underlying behaviour of the command.
 
 The string array flags can be a bit confusing. See the [String Array Flags](#string-array-flags) section for more information.
 
-| Name                  | Flag          | Type     | Example                                                   | Description |
-|:----------------------|:--------------|:---------|:----------------------------------------------------------|:------------|
+| Name                  | Flag                  | Type     | Example                                                   | Description |
+|:----------------------|:----------------------|:---------|:----------------------------------------------------------|:------------|
 | Config File Path      | `-conf`               | string   | `yamlfmt -conf ./config/.yamlfmt`                         | Specify a path to read a [configuration file](./config-file.md) from. |
 | Global Config         | `-global_conf`        | bool     | `yamlfmt -global_conf`                                    | Force yamlfmt to use the configuration file from the system config directory. |
 | Disable Global Config | `-no_global_conf`     | bool     | `yamlfmt -no_global_conf`                                 | Disable looking for the configuration file from the system config directory. |
-| Doublestar            | `-dstar`              | bool     | `yamlfmt -dstar "**/*.yaml"`                              | Enable [Doublestar](./paths.md#doublestar) path collection mode. |
-| Exclude               | `-exclude`            | []string | `yamlfmt -exclude ./not/,these_paths.yaml`                | Patterns to exclude from path collection. These add to exclude patterns specified in the [config file](./config-file.md) |
-| Gitignore Excludes    | `-gitignore_excludes` | bool     | `yamlfmt -gitignore_excludes`                             | Use a gitignore file to exclude paths. This is in addition to specified exclude patterns. |
+| Doublestar            | `-dstar`              | bool     | `yamlfmt -dstar "**/*.yaml"`                              | Enable [Doublestar](./paths.md#doublestar) path collection mode. Note that doublestar patterns should be specified with quotes in bash to prevent shell expansion. |
+| Exclude               | `-exclude`            | []string | `yamlfmt -exclude ./not/,these_paths.yaml`                | Patterns to exclude from path collection. These are in addition to the exclude patterns specified in the [config file](./config-file.md) |
+| Gitignore Excludes    | `-gitignore_excludes` | bool     | `yamlfmt -gitignore_excludes`                             | Use a gitignore file to exclude paths. This is in addition to otherwise specified exclude patterns. |
 | Gitignore Path        | `-gitignore_path`     | string   | `yamlfmt -gitignore_path .special_gitignore`              | Specify a path to a gitignore file to use. Defaults to `.gitignore` (in working directory). |
 | Extensions            | `-extensions`         | []string | `yamlfmt -extensions yaml,yml`                            | Extensions to use in standard path collection. Has no effect in Doublestar mode. These add to extensions specified in the [config file](./config-file.md)
 | Formatter Config      | `-formatter`          | []string | `yamlfmt -formatter indent=2,include_document_start=true` | Provide configuration values for the formatter. See [Formatter Configuration Options](./config-file.md#basic-formatter) for options. Each field is specified as `configkey=value`. |