From b15386e849b9fea347e7b17307eedf779d8022fc Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 12 Nov 2019 07:07:43 -0800 Subject: [PATCH] doc update --- docs/utils.md | 7 +++++-- jc/utils.py | 9 ++++++--- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/utils.md b/docs/utils.md index 815a8f3c..6c311cb9 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -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 diff --git a/jc/utils.py b/jc/utils.py index 73c3aed1..c7ba0550 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -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]