From 31b69b3242eeca2c02f87c31d58193dd3f06fe49 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sat, 25 Sep 2021 08:23:46 -0700 Subject: [PATCH] formatting --- docs/utils.md | 6 +++--- jc/utils.py | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/utils.md b/docs/utils.md index 2cf03381..91a438bf 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -125,14 +125,14 @@ Returns: ```python stream_success(output_line, ignore_exceptions) ``` -add _jc_meta object to output line if -qq (ignore_exceptions) option is used +Add `_jc_meta` object to output line if `ignore_exceptions=True` ## stream_error ```python stream_error(e, ignore_exceptions, line) ``` -reraise the stream exception with annotation or print an error _jc_meta -field if ignore_exceptions=True +Reraise the stream exception with annotation or print an error `_jc_meta` +field if `ignore_exceptions=True` ## timestamp diff --git a/jc/utils.py b/jc/utils.py index 7c2d82cc..bbf135ce 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -210,7 +210,7 @@ def convert_to_bool(value): def stream_success(output_line, ignore_exceptions): - """add _jc_meta object to output line if -qq (ignore_exceptions) option is used""" + """Add `_jc_meta` object to output line if `ignore_exceptions=True`""" if ignore_exceptions: output_line.update({'_jc_meta': {'success': True}}) @@ -218,8 +218,8 @@ def stream_success(output_line, ignore_exceptions): def stream_error(e, ignore_exceptions, line): - """reraise the stream exception with annotation or print an error _jc_meta - field if ignore_exceptions=True + """Reraise the stream exception with annotation or print an error `_jc_meta` + field if `ignore_exceptions=True` """ if not ignore_exceptions: e.args = (str(e) + '... Use the ignore_exceptions option (-qq) to ignore streaming parser errors.',)