From 795802bf04faefa117eaaa2a21cc2a5edb284b87 Mon Sep 17 00:00:00 2001
From: iamashwin99 <ashwin-kumar.karnad@mpsd.mpg.de>
Date: Mon, 7 Aug 2023 15:21:09 +0200
Subject: [PATCH] add doc string to remove_spack_package
---
src/mpsd_software_manager/mpsd_software.py | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/src/mpsd_software_manager/mpsd_software.py b/src/mpsd_software_manager/mpsd_software.py
index 0d09055..99ac220 100755
--- a/src/mpsd_software_manager/mpsd_software.py
+++ b/src/mpsd_software_manager/mpsd_software.py
@@ -1182,7 +1182,18 @@ def remove_spack_environment(spack_dir, environment_name):
def remove_spack_package(spack_dir, package):
- """Remove spack package."""
+ """Remove spack package.
+
+ Used to remove global packages.
+
+ Parameters
+ ----------
+ spack_dir : pathlib.Path
+ A Path object representing the path to the spack directory.
+ package : str
+ A string representing the name of the spack package to remove.
+
+ """
logging.info(f"Removing spack package {package}")
spack_env = spack_dir / "share" / "spack" / "setup-env.sh"
commands_to_execute = [
--
GitLab