diff --git a/docs/utils.md b/docs/utils.md index 79e5e704..b0df4081 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -194,7 +194,7 @@ Reraise the stream exception with annotation or print an error def input_type_check(data: str) -> None ``` -Ensure input data is a string. Raises TypeError if not. +Ensure input data is a string. Raises `TypeError` if not. @@ -205,7 +205,7 @@ def streaming_input_type_check(data: Iterable) -> None ``` Ensure input data is an iterable, but not a string or bytes. Raises -TypeError if not. +`TypeError` if not. @@ -215,7 +215,7 @@ TypeError if not. def streaming_line_input_type_check(line: str) -> None ``` -Ensure each line is a string. Raises TypeError if not. +Ensure each line is a string. Raises `TypeError` if not. diff --git a/jc/utils.py b/jc/utils.py index f907f143..ef541c36 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -249,7 +249,7 @@ def stream_error(e: BaseException, ignore_exceptions: bool, line: str) -> Dict: def input_type_check(data: str) -> None: - """Ensure input data is a string. Raises TypeError if not.""" + """Ensure input data is a string. Raises `TypeError` if not.""" if not isinstance(data, str): raise TypeError("Input data must be a 'str' object.") @@ -257,14 +257,14 @@ def input_type_check(data: str) -> None: def streaming_input_type_check(data: Iterable) -> None: """ Ensure input data is an iterable, but not a string or bytes. Raises - TypeError if not. + `TypeError` if not. """ if not hasattr(data, '__iter__') or isinstance(data, (str, bytes)): raise TypeError("Input data must be a non-string iterable object.") def streaming_line_input_type_check(line: str) -> None: - """Ensure each line is a string. Raises TypeError if not.""" + """Ensure each line is a string. Raises `TypeError` if not.""" if not isinstance(line, str): raise TypeError("Input line must be a 'str' object.")