Skip to content
Snippets Groups Projects
Commit d3128ea1 authored by Ashwin Kumar Karnad's avatar Ashwin Kumar Karnad
Browse files

Restructure doc string of setup_log_cmd

parent 1c3897b1
No related branches found
No related tags found
3 merge requests!19Move linux-debian11 into main,!13Restructure doc strings,!11Making docstrings comply with numpydoc
Pipeline #368403 failed
...@@ -14,6 +14,7 @@ This function builds toolchains for MPSD-HPC at the appropriate directory, \n ...@@ -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 for given system architecture and MPSD software stack version.\n
The toolchains The toolchains
are built using the bash script spack_setup.sh, and the results are logged. """ are built using the bash script spack_setup.sh, and the results are logged. """
config_vars = { config_vars = {
"cmd_log_file": "install.log", "cmd_log_file": "install.log",
"build_log_file": ( "build_log_file": (
...@@ -47,20 +48,23 @@ class os_chdir: ...@@ -47,20 +48,23 @@ class os_chdir:
def setup_log_cmd( def setup_log_cmd(
mpsd_release: str, script_dir: str, msg: str = None, *args, **kwargs mpsd_release: str, script_dir: str, msg: str = None, *args, **kwargs
) -> None: ) -> None:
"""The setup_log_cmd function logs the command used to build the """
toolchains, along with information about the software environment installer The setup_log_cmd function logs the command used to build the toolchains, along with information about the software
branch, the Spack environments branch, and the commit hashes of each. It environment installer branch, the Spack environments branch, and the commit hashes of each. It also logs steps taken
also logs steps taken in install process using the optional message in the install process using the optional message argument.
argument.
Parameters
Args: ----------
mpsd_release (str): The name of the release to install toolchains for. - mpsd_release : str
script_dir (str): The path to the directory where the scripts are located. The name of the release to install toolchains for.
msg (str, optional): An optional message to log in the command log file. - script_dir : str
The path to the directory where the scripts are located.
Returns: - msg : str, optional
None An optional message to log in the command log file.
Returns
-------
- None
""" """
release_base_dir = script_dir / mpsd_release release_base_dir = script_dir / mpsd_release
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment