1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-12-13 23:56:37 +02:00

update docs

This commit is contained in:
Kelly Brazil
2019-11-11 18:30:46 -08:00
parent 363fd3eab4
commit 146e29f7cb
47 changed files with 5370 additions and 2233 deletions

22
docs/utils.md Normal file
View File

@@ -0,0 +1,22 @@
# utils
jc - JSON CLI output utility utils
## warning_message
```python
warning_message(message)
```
Prints a warning message for non-fatal issues
## error_message
```python
error_message(message)
```
Prints an error message for fatal issues
## compatibility
```python
compatibility(mod_name, compatible)
```
Checks for the parser's compatibility with the running OS platform.
compatible options:
linux, darwin, cygwin, win32, aix, freebsd