From d3128ea1ae6e47b15cf68d53cda7c9aff8940058 Mon Sep 17 00:00:00 2001
From: iamashwin99 <ashwin-kumar.karnad@mpsd.mpg.de>
Date: Tue, 30 May 2023 14:06:34 +0200
Subject: [PATCH] Restructure doc string of setup_log_cmd
---
mpsd-software-environment.py | 30 +++++++++++++++++-------------
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/mpsd-software-environment.py b/mpsd-software-environment.py
index 7653de7..155aa3a 100755
--- a/mpsd-software-environment.py
+++ b/mpsd-software-environment.py
@@ -14,6 +14,7 @@ This function builds toolchains for MPSD-HPC at the appropriate directory, \n
for given system architecture and MPSD software stack version.\n
The toolchains
are built using the bash script spack_setup.sh, and the results are logged. """
+
config_vars = {
"cmd_log_file": "install.log",
"build_log_file": (
@@ -47,20 +48,23 @@ class os_chdir:
def setup_log_cmd(
mpsd_release: str, script_dir: str, msg: str = None, *args, **kwargs
) -> None:
- """The setup_log_cmd function logs the command used to build the
- toolchains, along with information about the software environment installer
- branch, the Spack environments branch, and the commit hashes of each. It
- also logs steps taken in install process using the optional message
- argument.
-
- Args:
- mpsd_release (str): The name of the release to install toolchains for.
- script_dir (str): The path to the directory where the scripts are located.
- msg (str, optional): An optional message to log in the command log file.
-
- Returns:
- None
+ """
+ The setup_log_cmd function logs the command used to build the toolchains, along with information about the software
+ environment installer branch, the Spack environments branch, and the commit hashes of each. It also logs steps taken
+ in the install process using the optional message argument.
+
+ Parameters
+ ----------
+ - mpsd_release : str
+ The name of the release to install toolchains for.
+ - script_dir : str
+ The path to the directory where the scripts are located.
+ - msg : str, optional
+ An optional message to log in the command log file.
+ Returns
+ -------
+ - None
"""
release_base_dir = script_dir / mpsd_release
--
GitLab