Add docstrings to exchange classes for better help text

jupyter · Jan 4, 2024 · fcbe7ea · fcbe7ea
1 parent 4c51c81
commit fcbe7ea
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/nbgrader/exchange/abc/exchange.py b/nbgrader/exchange/abc/exchange.py
@@ -1,5 +1,5 @@
 import datetime
-from abc import ABC, abstractmethod
+from abc import abstractmethod
 
 from textwrap import dedent
 
@@ -17,6 +17,10 @@ class ExchangeError(Exception):
 
 
 class ABCExchange(LoggingConfigurable):
+    """
+    The abstract Exchange, which underlies every step in the exchange process.
+    """
+
     assignment_dir = Unicode(
         ".",
         help=dedent(

diff --git a/nbgrader/exchange/default/exchange.py b/nbgrader/exchange/default/exchange.py
@@ -17,6 +17,10 @@
 
 
 class Exchange(ABCExchange):
+    """
+    The default implementation of an Exchange based on the local file system.
+    """
+
     root = Unicode(
         "/usr/local/share/nbgrader/exchange",
         help="The nbgrader exchange directory writable to everyone. MUST be preexisting."