From 996d77cc894b784cc918d2c6109c71b577baef98 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Thu, 22 Jan 2015 21:23:12 +0000 Subject: [PATCH] Add documentation to check_nbextension, and switch order of parameters to be consistent with install_nbextension. --- IPython/html/nbextensions.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/IPython/html/nbextensions.py b/IPython/html/nbextensions.py index a5a099024..293ab8133 100644 --- a/IPython/html/nbextensions.py +++ b/IPython/html/nbextensions.py @@ -106,12 +106,24 @@ def _get_nbext_dir(nbextensions_dir=None, user=False, prefix=None): return nbext -def check_nbextension(files, nbextensions_dir=None, user=False, prefix=None): +def check_nbextension(files, user=False, prefix=None, nbextensions_dir=None): """Check whether nbextension files have been installed - files should be a list of relative paths within nbextensions. - Returns True if all files are found, False if any are missing. + + Parameters + ---------- + + files : list(paths) + a list of relative paths within nbextensions. + user : bool [default: False] + Whether to check the user's .ipython/nbextensions directory. + Otherwise check a system-wide install (e.g. /usr/local/share/jupyter/nbextensions). + prefix : str [optional] + Specify install prefix, if it should differ from default (e.g. /usr/local). + Will check prefix/share/jupyter/nbextensions + nbextensions_dir : str [optional] + Specify absolute path of nbextensions directory explicitly. """ nbext = _get_nbext_dir(nbextensions_dir, user, prefix) # make sure nbextensions dir exists @@ -346,4 +358,4 @@ class NBExtensionApp(BaseIPythonApplication): if __name__ == '__main__': NBExtensionApp.launch_instance() - \ No newline at end of file +