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

add doc string to get_important_folders

parent fb542664
No related branches found
No related tags found
1 merge request!130Resolve "single function to generate all the folders relative to root_dir"
......@@ -137,7 +137,21 @@ def get_important_folders(
root_dir: Path,
):
"""
Returns a dictionary of important folders for scripts, as currently envisioned.
Returns a dictionary of important folders for scripts.
Parameters
----------
mpsd_release : str
The MPSD release version.
root_dir : Path
The root directory.
Returns
-------
dict
A dictionary containing the important folders for scripts.
currently: release_base_dir, microarch, package_set_dir, spack_dir,
lmod_dir, spack_setup_script, logs_dir, repo_path
"""
release_base_dir = root_dir / mpsd_release
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment