Fix docstrings

optuna · Jun 7, 2022 · 616dff2 · 616dff2
1 parent f7e7098
commit 616dff2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/optuna/_deprecated.py b/optuna/_deprecated.py
@@ -61,7 +61,7 @@ def deprecated_func(
         removed_version:
             The version in which the target feature will be removed.
         name:
-            The name of the feature. Defaults to the function or class name. Optional.
+            The name of the feature. Defaults to the function name. Optional.
         text:
             The additional text for the deprecation note. The default note is build using specified
             ``deprecated_version`` and ``removed_version``. If you want to provide additional
@@ -128,7 +128,7 @@ def deprecated_class(
         removed_version:
             The version in which the target feature will be removed.
         name:
-            The name of the feature. Defaults to the function or class name. Optional.
+            The name of the feature. Defaults to the class name. Optional.
         text:
             The additional text for the deprecation note. The default note is build using specified
             ``deprecated_version`` and ``removed_version``. If you want to provide additional

diff --git a/optuna/_experimental.py b/optuna/_experimental.py
@@ -45,7 +45,7 @@ def experimental_func(
 
     Args:
         version: The first version that supports the target feature.
-        name: The name of the feature. Defaults to the function or class name. Optional.
+        name: The name of the feature. Defaults to the function name. Optional.
     """
 
     _validate_version(version)
@@ -80,6 +80,12 @@ def experimental_class(
     version: str,
     name: Optional[str] = None,
 ) -> Callable[[CT], CT]:
+    """Decorate class as experimental.
+
+    Args:
+        version: The first version that supports the target feature.
+        name: The name of the feature. Defaults to the class name. Optional.
+    """
 
     _validate_version(version)