Updated instructions w.r.t keys and values starting with dashes

mkdocs/create.md

@@ -41,4 +41,4 @@ You can also pipe the instructions in:
 cat create_instructions.yaml | yq n -s -
 ```
 
-{!snippets/keys_with_dots.md!}
+{!snippets/niche.md!}

mkdocs/delete.md

@@ -107,4 +107,4 @@ b:
 
 Note that '*' is in quotes to avoid being interpreted by your shell.
 
-{!snippets/keys_with_dots.md!}
+{!snippets/niche.md!}

mkdocs/read.md

@@ -122,4 +122,4 @@ will output:
 ```
 Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
 
-{!snippets/keys_with_dots.md!}
+{!snippets/niche.md!}

mkdocs/snippets/keys_with_dots.md

@@ -1,19 +0,0 @@
-### Keys with dots
-When specifying a key that has a dot use key lookup indicator.
-
-```yaml
-b:
-  foo.bar: 7
-```
-
-```bash
-yaml r sample.yaml 'b[foo.bar]'
-```
-
-```bash
-yaml w sample.yaml 'b[foo.bar]' 9
-```
-
-Any valid yaml key can be specified as part of a key lookup.
-
-Note that the path is in quotes to avoid the square brackets being interpreted by your shell.

mkdocs/snippets/niche.md

@@ -0,0 +1,35 @@
+### Keys with dots
+When specifying a key that has a dot use key lookup indicator.
+
+```yaml
+b:
+  foo.bar: 7
+```
+
+```bash
+yaml r sample.yaml 'b[foo.bar]'
+```
+
+```bash
+yaml w sample.yaml 'b[foo.bar]' 9
+```
+
+Any valid yaml key can be specified as part of a key lookup.
+
+Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
+
+### Keys (and values) with leading dashes
+If a key or value has leading dashes, yq won't know that you are passing a value as opposed to a flag (and you will get a 'bad flag syntax' error).
+
+To fix that, you will need to tell it to stop processing flags by adding '--' after the last flag like so:
+
+
+```bash
+yq n -t -- --key --value
+```
+
+Will result in
+
+```
+--key: --value
+```

mkdocs/write.md

@@ -169,4 +169,4 @@ my:
   path: -3
 ```
 
-{!snippets/keys_with_dots.md!}
+{!snippets/niche.md!}