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 07:07:43 -08:00
parent d2a2c8da35
commit b15386e849
2 changed files with 11 additions and 5 deletions

View File

@ -16,7 +16,10 @@ compatibility(mod_name, compatible)
```
Checks for the parser's compatibility with the running OS platform.
compatible options:
Arguments:
linux, darwin, cygwin, win32, aix, freebsd
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

View File

@ -23,10 +23,13 @@ def error_message(message):
def compatibility(mod_name, compatible):
"""Checks for the parser's compatibility with the running OS platform.
Arguments:
compatible options:
linux, darwin, cygwin, win32, aix, freebsd
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
"""
if sys.platform not in compatible:
mod = mod_name.split('.')[-1]