python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2019-11-12 07:07:43 -08:00
parent d2a2c8da35
commit b15386e849
2 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/utils.md
View File

@ -16,7 +16,10 @@ compatibility(mod_name, compatible)
``` ```
Checks for the parser's compatibility with the running OS platform. Checks for the parser's compatibility with the running OS platform.
compatible options: Arguments:
mod_name (string) __name__ of the calling module
compatible (list) sys.platform name(s) compatible with the parser
compatible options:
linux, darwin, cygwin, win32, aix, freebsd linux, darwin, cygwin, win32, aix, freebsd

5
jc/utils.py
View File

@ -24,8 +24,11 @@ def error_message(message):
def compatibility(mod_name, compatible): def compatibility(mod_name, compatible):
"""Checks for the parser's compatibility with the running OS platform. """Checks for the parser's compatibility with the running OS platform.
compatible options: Arguments:
mod_name (string) __name__ of the calling module
compatible (list) sys.platform name(s) compatible with the parser
compatible options:
linux, darwin, cygwin, win32, aix, freebsd linux, darwin, cygwin, win32, aix, freebsd
""" """
if sys.platform not in compatible: if sys.platform not in compatible: