]> granicus.if.org Git - jq/commitdiff
manual.yml: Clarify how to specify keys with ":" and special chars.
authortal@whatexit.org <tal@whatexit.org>
Fri, 3 Apr 2015 13:53:51 +0000 (13:53 +0000)
committerNicolas Williams <nico@cryptonector.com>
Thu, 16 Apr 2015 16:09:49 +0000 (11:09 -0500)
Signed-off-by: Nicolas Williams <nico@cryptonector.com>
docs/content/3.manual/manual.yml

index f9fdc03451167e83e1ba28ce19acbc7de3fbb5b9..a19ca6ad84a587ab1a0c9e8558628b14324ad58f 100644 (file)
@@ -301,6 +301,12 @@ sections:
           to the last element, -2 referring to the next to last element,
           and so on.
 
+          The `.foo` syntax only works for simply keys i.e. keys that
+          are all alphanumeric characters. `.[<string>]` works with
+          keys that contain special charactors such as colons and dots.
+          For example `.["foo::bar"]` and `.["foo.bar"]` work while
+          `.foo::bar` and `.foo.bar` would not.
+
           The `?` "operator" can also be used with the slice operator,
           as in `.[10:15]?`, which outputs values where the inputs are
           slice-able.