1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00

docstring update

This commit is contained in:
Kelly Brazil
2022-05-23 13:16:57 -07:00
parent cfb71c7dad
commit 176ca2f75d

View File

@ -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