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

doc update

This commit is contained in:
Kelly Brazil
2019-11-12 14:19:40 -08:00
parent 7e6a1bc719
commit e17388d3b2
2 changed files with 44 additions and 4 deletions

View File

@ -4,7 +4,17 @@ import sys
def warning_message(message):
"""Prints a warning message for non-fatal issues"""
"""
Prints a warning message for non-fatal issues
Parameters:
message (string) text of message
Returns:
no return, just prints output to STDERR
"""
error_string = f'''
jc: Warning - {message}
@ -13,7 +23,17 @@ def warning_message(message):
def error_message(message):
"""Prints an error message for fatal issues"""
"""
Prints an error message for fatal issues
Parameters:
message (string) text of message
Returns:
no return, just prints output to STDERR
"""
error_string = f'''
jc: Error - {message}
@ -24,7 +44,7 @@ def error_message(message):
def compatibility(mod_name, compatible):
"""Checks for the parser's compatibility with the running OS platform.
Arguments:
Parameters:
mod_name (string) __name__ of the calling module