Update docstring for viewshed (#807)

makepath · Oct 29, 2024 · 6dd5faa · 6dd5faa
1 parent 555706c
commit 6dd5faa
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/xrspatial/viewshed.py b/xrspatial/viewshed.py
@@ -1606,15 +1606,19 @@ def viewshed(raster: xarray.DataArray,
     observer_elev : float
         Observer elevation above the terrain.
     target_elev : float
-        Target elevation offset above the terrain.
+        Target elevation offset above the terrain, which is the height
+        in surface units to be added to the z-value of each pixel
+        when it is being analyzed for visibility.
 
     Returns
     -------
     viewshed: xarray.DataArray
         A cell x in the visibility grid is recorded as follows:
         If it is invisible, then x is set to INVISIBLE.
         If it is visible,  then x is set to the vertical angle w.r.t
-        the viewpoint.
+        the viewpoint. The value returned is in [0, 180]. A value of 0 is
+        directly below the specified viewing position,
+        90 is due horizontal, and 180 is directly above the observer.
 
     Examples
     --------