From 1e656d030ae996c480dd7c8e4d699bbe828710ae Mon Sep 17 00:00:00 2001
From: Chen Kasirer <ckasirer@ethz.ch>
Date: Wed, 14 Aug 2024 16:14:00 +0200
Subject: [PATCH] docstring and cleanup

---
 src/compas_rhino/install.py | 68 +++++++++++++++++--------------------
 1 file changed, 31 insertions(+), 37 deletions(-)

diff --git a/src/compas_rhino/install.py b/src/compas_rhino/install.py
index 4fd974c813b..a283b48d596 100644
--- a/src/compas_rhino/install.py
+++ b/src/compas_rhino/install.py
@@ -13,12 +13,41 @@
 
 
 def install(version=None, packages=None, clean=False):
-    print("install invoked with version: {}".format(version))
+    """Install COMPAS for Rhino.
+
+    Parameters
+    ----------
+    version : {'5.0', '6.0', '7.0', '8.0'}, optional
+        The version number of Rhino.
+        When not specified, installation would be attempted for all supported versions.
+    packages : list of str, optional
+        List of packages to install or None to use default package list.
+        Default is the result of ``installable_rhino_packages``,
+        which collects all installable packages in the current environment.
+    clean : bool, optional
+        If True, this will clean up the entire scripts folder and remove
+        also existing symlinks that are not importable in the current environment.
+
+    Examples
+    --------
+    .. code-block:: python
+
+        import compas_rhino.install
+
+        compas_rhino.install.install()
+
+    .. code-block:: bash
+
+        python -m compas_rhino.install
+
+    """
     if version is None:
         versions = compas_rhino.SUPPORTED_VERSIONS
     else:
         versions = [version]
+
     for spec in _make_specs(packages, clean, versions):
+        # specs are tuples of (installation_path, version, packages, clean)
         _install(*spec)
 
 
@@ -48,46 +77,12 @@ def _make_rhino8_cpython_specs(packages, clean):
 
 
 def _install(installation_path, version=None, packages=None, clean=False):
-    """Install COMPAS for Rhino.
-
-    Parameters
-    ----------
-    version : {'5.0', '6.0', '7.0', '8.0'}, optional
-        The version number of Rhino.
-        Default is ``'7.0'``.
-    packages : list of str, optional
-        List of packages to install or None to use default package list.
-        Default is the result of ``installable_rhino_packages``,
-        which collects all installable packages in the current environment.
-    clean : bool, optional
-        If True, this will clean up the entire scripts folder and remove
-        also existing symlinks that are not importable in the current environment.
-
-    Examples
-    --------
-    .. code-block:: python
-
-        import compas_rhino.install
-
-        compas_rhino.install.install()
-
-    .. code-block:: bash
-
-        python -m compas_rhino.install
-
-    """
     version = compas_rhino._check_rhino_version(version)
 
     # We install COMPAS packages in the scripts folder
     # instead of directly as IPy module.
     # scripts_path = compas_rhino._get_rhino_scripts_path(version)
 
-    # # In Rhino 8 there is no scripts folder
-    # if version == "8.0":
-    #     installation_path = compas_rhino._get_default_rhino_ironpython_sitepackages_path(version)
-    # else:
-    #     installation_path = compas_rhino._get_rhino_scripts_path(version)
-
     # This is for old installs
     ipylib_path = compas_rhino._get_rhino_ironpython_lib_path(version)
 
@@ -405,8 +400,7 @@ def _filter_installable_packages(version, packages):
         "-v",
         "--version",
         choices=compas_rhino.SUPPORTED_VERSIONS,
-        # default=compas_rhino.DEFAULT_VERSION,
-        help="The version of Rhino to install the packages in.",
+        help="The version of Rhino to install the packages in. If not specified, all supported versions will be attempted.",
     )
     parser.add_argument("-p", "--packages", nargs="+", help="The packages to install.")
     parser.add_argument("-c", "--clean", default=False, action="store_true", help="Clean up the installation directory")