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

Try to fix doc string of get_release_info

parent 59061ac3
No related branches found
No related tags found
3 merge requests!19Move linux-debian11 into main,!13Restructure doc strings,!11Making docstrings comply with numpydoc
...@@ -128,7 +128,7 @@ def create_dir_structure(mpsd_release: str, script_dir: Path) -> None: ...@@ -128,7 +128,7 @@ def create_dir_structure(mpsd_release: str, script_dir: Path) -> None:
The create_dir_structure function creates the directory structure for The create_dir_structure function creates the directory structure for
the specified release and clones the Spack environments repository if it the specified release and clones the Spack environments repository if it
doesn't exist. doesn't exist.
Parameters Parameters
---------- ----------
- mpsd_release: A string representing the MPSD release version. - mpsd_release: A string representing the MPSD release version.
...@@ -173,29 +173,28 @@ def get_release_info(mpsd_release: str, script_dir: Path) -> Tuple[str, str, Lis ...@@ -173,29 +173,28 @@ def get_release_info(mpsd_release: str, script_dir: Path) -> Tuple[str, str, Lis
Get information about the specified release, such as the branch and commit hash Get information about the specified release, such as the branch and commit hash
of the Spack environments repository and the available toolchains. of the Spack environments repository and the available toolchains.
Args Parameters
---- ----------
mpsd_release : str mpsd_release : str
the name of the release to get information for. The name of the release to get information for.
script_dir : pathlib.Path script_dir : pathlib.Path
the base directory where releases are stored. The base directory where releases are stored.
Returns Returns
------- -------
spe_branch : str spe_branch : str
the name of the branch for the Spack environments repository. The name of the branch for the Spack environments repository.
spe_commit_hash : str spe_commit_hash : str
the commit hash for the Spack environments repository. The commit hash for the Spack environments repository.
available_toolchains : list available_toolchains : list
a list of strings representing the available A list of strings representing the available toolchains for the release.
toolchains for the release.
Raises Raises
------ ------
FileNotFoundError : FileNotFoundError
If the release directory does not exist. Run `create_dir_structure()` If the release directory does not exist. Run `create_dir_structure()` first.
first.
""" """
# Get the info for release # Get the info for release
release_base_dir = script_dir / mpsd_release release_base_dir = script_dir / mpsd_release
if not os.path.exists(release_base_dir): if not os.path.exists(release_base_dir):
......
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