1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/utils.md

47 lines
863 B
Markdown
Raw Normal View History

2019-11-11 18:30:46 -08:00
# utils
jc - JSON CLI output utility utils
## warning_message
```python
warning_message(message)
```
2019-11-12 14:19:40 -08:00
2019-11-11 18:30:46 -08:00
Prints a warning message for non-fatal issues
2019-11-12 14:19:40 -08:00
Parameters:
message (string) text of message
Returns:
no return, just prints output to STDERR
2019-11-11 18:30:46 -08:00
## error_message
```python
error_message(message)
```
2019-11-12 14:19:40 -08:00
2019-11-11 18:30:46 -08:00
Prints an error message for fatal issues
2019-11-12 14:19:40 -08:00
Parameters:
message (string) text of message
Returns:
no return, just prints output to STDERR
2019-11-11 18:30:46 -08:00
## compatibility
```python
compatibility(mod_name, compatible)
```
Checks for the parser's compatibility with the running OS platform.
2019-11-12 14:19:40 -08:00
Parameters:
2019-11-11 18:30:46 -08:00
2019-11-12 07:07:43 -08:00
mod_name (string) __name__ of the calling module
2019-11-12 07:08:35 -08:00
2019-11-12 07:07:43 -08:00
compatible (list) sys.platform name(s) compatible with the parser
compatible options:
linux, darwin, cygwin, win32, aix, freebsd
2019-11-11 18:30:46 -08:00