From 7857e7b9fd8878e694c212e1ed9b717277c0fbdf Mon Sep 17 00:00:00 2001 From: nh916 Date: Wed, 30 Aug 2023 12:46:31 -0700 Subject: [PATCH] upgraded documentation for `cript.API.verobose` added example code and example log --- src/cript/api/api.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/cript/api/api.py b/src/cript/api/api.py index dd7f5817f..4c6fe5a39 100644 --- a/src/cript/api/api.py +++ b/src/cript/api/api.py @@ -287,9 +287,15 @@ def verbose(self) -> bool: to the terminal. This can be useful for debugging and understanding the internal workings of the class. - When `verbose` is set to `False`, the class will only provide essential and concise - logging information, making the terminal output less cluttered and more user-friendly. + ```bash + INFO: Validating Project graph... + ``` + + When `verbose` is set to `False`, the class will only provide essential logging information, + making the terminal output less cluttered and more user-friendly. + Examples + -------- ```python # turn off the terminal logs api.verbose = False