From c9fccd77ef75be2c416314ee8b1d7850de276e0a Mon Sep 17 00:00:00 2001 From: Andrey Kislyuk Date: Thu, 29 Feb 2024 21:17:35 -0800 Subject: [PATCH] Update README.rst Add note about comments --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index d5809da..6fd5508 100644 --- a/README.rst +++ b/README.rst @@ -103,6 +103,8 @@ parses this metadata, re-applies the tags and styles, and discards the extra pai 4 entries instead of 2. A filter that expects all array entries to be mappings may break due to the presence of string metadata keys. Check your jq filter for compatibility/semantic validity when using the ``-Y`` option. +yq does not support passing YAML comments into the JSON representation used by jq, or roundtripping such comments. + XML support ----------- ``yq`` also supports XML. The ``yq`` package installs an executable, ``xq``, which