get_dataset_default_config_name docstring (#6723)

huggingface · Mar 7, 2024 · 6fb6c83 · 6fb6c83
1 parent f45bc6c
commit 6fb6c83
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/datasets/inspect.py b/src/datasets/inspect.py
@@ -369,6 +369,7 @@ def get_dataset_default_config_name(
     **download_kwargs,
 ) -> Optional[str]:
     """Get the default config name for a particular dataset.
+    Can return None only if the dataset has multiple configurations and no default configuration.
 
     Args:
         path (`str`): path to the dataset processing script with the dataset builder. Can be either:
@@ -397,7 +398,7 @@ def get_dataset_default_config_name(
             for example `token`.
 
     Returns:
-        Optional[str]
+        Optional[str]: the default config name if there is one
 
     Example: