From 176ca2f75d5bfa8353cc22b233653dbe34d11922 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 23 May 2022 13:16:57 -0700 Subject: [PATCH] docstring update --- jc/cli.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/jc/cli.py b/jc/cli.py index a48fef31..9fbddd85 100644 --- a/jc/cli.py +++ b/jc/cli.py @@ -264,7 +264,10 @@ def versiontext(): def yaml_out(data, pretty=False, env_colors=None, mono=False, piped_out=False, ascii_only=False): - """Return a YAML formatted string""" + """ + Return a YAML formatted string. String may include color codes. If the + YAML library is not installed, output will fall back to JSON with a + warning message to STDERR""" # make ruamel.yaml import optional try: from ruamel.yaml import YAML