📝 Add option and id links to documentation

cds-astro · May 21, 2024 · bc8d0b7 · bc8d0b7
1 parent 32175ca
commit bc8d0b7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/examples/2_Base_Commands.ipynb b/examples/2_Base_Commands.ipynb
@@ -133,7 +133,11 @@
   {
    "metadata": {},
    "cell_type": "markdown",
-   "source": "You can add a hips survey from an url or an id (id list: https://aladin.cds.unistra.fr/hips/list)"
+   "source": [
+    "You can add a hips survey from an url or an id\n",
+    "- ID list can be found here: https://aladin.cds.unistra.fr/hips/list\n",
+    "- HiPS options can be found here: https://cds-astro.github.io/aladin-lite/global.html#ImageHiPSOptions"
+   ]
   },
   {
    "metadata": {},

diff --git a/src/ipyaladin/aladin.py b/src/ipyaladin/aladin.py
@@ -189,8 +189,11 @@ def add_hips(self, src: str, **hips_options: any) -> None:
         Parameters
         ----------
         src: str
-            The URL of the HiPS survey.
+            The id or url of the HiPS survey.
+            List of survey ids: https://aladin.cds.unistra.fr/hips/list
         hips_options: keyword arguments
+            See https://cds-astro.github.io/aladin-lite/global.html#ImageHiPSOptions for
+            the list of available options.
 
         """
         self.send(