From 627c19e7917c932a7b0b25ebeb713691161f47bc Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Fri, 9 Jun 2023 15:27:28 +0200
Subject: [PATCH] update documentation strings
---
mpsd-software-environment.py | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/mpsd-software-environment.py b/mpsd-software-environment.py
index a2651bc..10bf6a5 100755
--- a/mpsd-software-environment.py
+++ b/mpsd-software-environment.py
@@ -835,14 +835,15 @@ def environment_status(mpsd_release: str, root_dir: Union[str, Path]) -> dict:
mpsd_release : str
A string representing the MPSD release version.
root_dir : pathlib.Path
- A Path object representing the path to the directory where
- the release and toolchains will be installed.
+ A Path object pointing to the root directory of the installation.
+ Expect a subfolder root/mpsd_release in which we search for the
+ toolchains.
Returns
-------
toolchain_map : dict
- A dictionary containing available microarchitectures as keys and
- a list of available toolchains as values for each microarchitecture.
+ A dictionary containing available microarchitectures as keys and
+ a list of available toolchains as values for each microarchitecture.
"""
msg = f"Showing status of release {mpsd_release} in {root_dir}"
logging.info(msg)
--
GitLab