add example to docstring

icesat2py · Feb 9, 2024 · 0f9f579 · 0f9f579
1 parent 00ca183
commit 0f9f579
Showing 1 changed file with 11 additions and 8 deletions.
diff --git a/icepyx/core/variables.py b/icepyx/core/variables.py
@@ -460,14 +460,6 @@ def append(self, defaults=False, var_list=None, beam_list=None, keyword_list=Non
 
         path_list : list of strings, default None
             A list of variable path names given as a the full path from the H5 root path.
-            For example: 
-
-            path_list = ['gt1l/heights/delta_time',
-                         'gt1l/heights/dist_ph_across',
-                         'gt1l/heights/dist_ph_along',
-                         'gt1l/heights/h_ph',
-                         'gt1l/heights/lat_ph',
-                         'gt1l/heights/lon_ph']
 
         Notes
         -----
@@ -494,6 +486,17 @@ def append(self, defaults=False, var_list=None, beam_list=None, keyword_list=Non
         To add all variables and paths in ancillary_data
 
         >>> reg_a.order_vars.append(keyword_list=['ancillary_data']) # doctest: +SKIP
+
+        To add variables as a list of explicit paths
+
+        >>> path_list = ['gt1l/heights/delta_time',
+                         'gt1l/heights/dist_ph_across',
+                         'gt1l/heights/dist_ph_along',
+                         'gt1l/heights/h_ph',
+                         'gt1l/heights/lat_ph',
+                         'gt1l/heights/lon_ph']
+        >>> region_a.order_vars.append(path_list=path_list)  # doctest: +SKIP
+
         """
 
         # Check that at least one allowable combination of keywords are set