From d390fdc641a5b7b7fa53b69726809cb4cac97e29 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Tue, 26 Oct 2021 14:33:57 +1100 Subject: [PATCH] better docs --- pkg/yqlib/doc/headers/Encoder and Decoder.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pkg/yqlib/doc/headers/Encoder and Decoder.md b/pkg/yqlib/doc/headers/Encoder and Decoder.md index 7e4d616a..c5ceec5a 100644 --- a/pkg/yqlib/doc/headers/Encoder and Decoder.md +++ b/pkg/yqlib/doc/headers/Encoder and Decoder.md @@ -1,3 +1,5 @@ Encode operators will take the piped in object structure and encode it as a string in the desired format. The decode operators do the opposite, they take a formatted string and decode it into the relevant object structure. +Note that you can optionally pass an indent value to the encode functions (see below). + These operators are useful to process yaml documents that have stringified embeded yaml/json/props in them. \ No newline at end of file