Description of "Set path to prune deep paths" example is wrong

[GrahamHannington]

The yq docs heading "Set path to prune deep paths" states:

This uses ireduce to deeply set the selected paths into an empty object.

However, the example that follows that statement does the "opposite"; it keeps only the selected paths.

The combination of input, expression, and output are correct. It's just the preceding statement that's wrong.

Suggested rewording (I acknowledge this is not be ideal; it's just a suggested starting point for further wordsmithing; I use "deeply prune" only to echo the heading):

This uses ireduce to deeply prune the input, leaving only the selected paths.

yq v4.44.6 on Windows 10 installed via binary release

[GrahamHannington]

Sorry, I was wrong. This is not a bug. This was me misunderstanding ireduce and, based on that misunderstanding, misreading the docs:

deeply set the selected paths into an empty object

No news to the author of this example 🙂 , but in case this is of any help to anyone who had similar trouble understanding ireduce (might be just me): the example does just that. The "empty object" here is the {} in the call to ireduce. ireduce sets the selected paths into that empty object. Hence, the output contains just the selected paths.

[GrahamHannington]

Wish I could close as "user error". @mikefarah , apologies if I've compounded my error by setting the wrong status on this issue 😬. Please feel free to delete this entire issue.