Add a warning about using it with several users on the same Jupyterla…

…b instance, and show the configuration by default in formgrader
jupyter · Jun 18, 2024 · abef5d7 · abef5d7
1 parent 3500886
commit abef5d7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/nbgrader/docs/source/configuration/nbgrader_config.rst b/nbgrader/docs/source/configuration/nbgrader_config.rst
@@ -70,9 +70,9 @@ Use Case 3: using config from a specific sub directory
 
 .. warning::
 
-    This option should not be used with a JupyterHub installation, as it modifies
+    This option should not be used with a multiuser Jupyterlab instance, as it modifies
     certain objects in the running instance, and can probably prevent other users
-    from using *formgrader* correctly. If you have a JupyterHub installation,
+    from using *formgrader* correctly. Also, if you have a JupyterHub installation,
     you should use the settings described in the following section.
 
 You may need to use a dedicated configuration file for each course without configuring

diff --git a/nbgrader/server_extensions/formgrader/formgrader.py b/nbgrader/server_extensions/formgrader/formgrader.py
@@ -19,7 +19,7 @@ class FormgradeExtension(NbGrader):
     description = u'Grade a notebook using an HTML form'
 
     debug = Bool(
-        False,
+        True,
         help=dedent(
             """
             Whether to display the loaded configuration in the 'Formgrader ->

diff --git a/schema/formgrader.json b/schema/formgrader.json
@@ -5,7 +5,7 @@
     "local_config": {
       "type": "boolean",
       "title": "Allow local nbgrader config file",
-      "description": "This setting allow the use of a local config file for formgrader.",
+      "description": "This setting allows the use of a local config file for formgrader.\nWARNING: using the local configuration file has consequences for the server, it should not be used if several users are using the same instance of Jupyterlab.",
       "default": false
     }
   },