Skip to content

Commit

Permalink
upgraded documentation for cript.API.verobose
Browse files Browse the repository at this point in the history
added example code and example log
  • Loading branch information
nh916 committed Aug 30, 2023
1 parent 95f0399 commit 7857e7b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/cript/api/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7857e7b

Please sign in to comment.