From c73b71104f06d0e92e0d04e4c41acddbb17d7691 Mon Sep 17 00:00:00 2001 From: maartenbreddels Date: Fri, 8 Dec 2017 15:40:17 +0100 Subject: [PATCH] added docstrings --- notebook/config_manager.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/notebook/config_manager.py b/notebook/config_manager.py index 12cd27d7d..d90e3e6ba 100644 --- a/notebook/config_manager.py +++ b/notebook/config_manager.py @@ -47,6 +47,7 @@ class BaseJSONConfigManager(LoggingConfigurable): read_directory = Bool(True) def ensure_config_dir_exists(self): + """Will try to create the config_dir directory.""" try: os.makedirs(self.config_dir, 0o755) except OSError as e: @@ -54,9 +55,11 @@ class BaseJSONConfigManager(LoggingConfigurable): raise def file_name(self, section_name): + """Returns the json filename for the section_name: {config_dir}/{section_name}.json""" return os.path.join(self.config_dir, section_name+'.json') def directory(self, section_name): + """Returns the directory name for the section name: {config_dir}/{section_name}.d""" return os.path.join(self.config_dir, section_name+'.d') def get(self, section_name):