add docstring to version.setbase

facebookresearch · Feb 24, 2024 · de3fbcc · de3fbcc
1 parent d4009b4
commit de3fbcc
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/hydra/version.py b/hydra/version.py
@@ -60,6 +60,10 @@ def getbase() -> Optional[Version]:
 
 
 def setbase(ver: Any) -> None:
+    """
+    Set the `version_base` parameter, which is used to support backward compatibility
+    with older versions of Hydra.
+    """
     if type(ver) is type(_UNSPECIFIED_):
         deprecation_warning(
             message=dedent(