From 706424a459412d1abb958abd702db2e583c9953e Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Tue, 5 Mar 2024 10:13:36 +1100 Subject: [PATCH] Improving column docs --- pkg/yqlib/doc/operators/column.md | 2 ++ pkg/yqlib/doc/operators/headers/column.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/pkg/yqlib/doc/operators/column.md b/pkg/yqlib/doc/operators/column.md index d2cef944..c9d9541f 100644 --- a/pkg/yqlib/doc/operators/column.md +++ b/pkg/yqlib/doc/operators/column.md @@ -2,6 +2,8 @@ Returns the column of the matching node. Starts from 1, 0 indicates there was no column data. +Column is the number of characters that precede that node on the line it starts. + ## Returns column of _value_ node Given a sample.yml file of: ```yaml diff --git a/pkg/yqlib/doc/operators/headers/column.md b/pkg/yqlib/doc/operators/headers/column.md index 6c999746..0e6c4a45 100644 --- a/pkg/yqlib/doc/operators/headers/column.md +++ b/pkg/yqlib/doc/operators/headers/column.md @@ -1,3 +1,5 @@ # Column Returns the column of the matching node. Starts from 1, 0 indicates there was no column data. + +Column is the number of characters that precede that node on the line it starts.