Fix documentation

logicalclocks · Nov 10, 2023 · b559340 · b559340
1 parent 33d0485
commit b559340
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/python/hopsworks/engine/execution_engine.py b/python/hopsworks/engine/execution_engine.py
@@ -31,9 +31,10 @@ def __init__(self, project_id=None):
 
     def download_logs(self, execution, path=None):
         """Download execution logs to current directory
-        :param path: path to download the logs
         :param execution: execution to download logs for
         :type execution: Execution
+        :param path: path to download the logs
+        :type path: str
         :return: downloaded stdout and stderr log path
         :rtype: str, str
         :raises: JobExecutionException if path is provided but does not exist

diff --git a/python/hopsworks/execution.py b/python/hopsworks/execution.py
@@ -180,7 +180,6 @@ def success(self):
 
     def download_logs(self, path=None):
         """Download stdout and stderr logs for the execution
-
         Example for downloading and printing the logs
 
         ```python
@@ -195,6 +194,9 @@ def download_logs(self, path=None):
         print(err_fd.read())
 
         ```
+
+        # Arguments
+            path: path to download the logs. must be `str`
         # Returns
             `str`. Path to downloaded log for stdout.
             `str`. Path to downloaded log for stderr.