doc: improve definition of 'clockwise' parameter (#57)

Author: vegard-solum-4ss

docs/user_guide/concepts_utils/grid.rst

@@ -33,8 +33,8 @@ a grid, we need information about the assumed 'wave convention'. Two boolean
 parameters are needed:
 
 *clockwise*
-    Describes the direction of positive rotation.
-
+    Describes the direction of positive rotation. ``clockwise=True`` means that the
+    directions follow the right-hand rule with an axis pointing downwards.
 *waves_coming_from*
     Describes the direction in which the waves are propagating.
 

src/waveresponse/_core.py

@@ -332,8 +332,9 @@ class Grid:
     degrees : bool
         If direction is given in 'degrees'. If ``False``, 'radians' is assumed.
     clockwise : bool
-        If positive directions are defined to be 'clockwise'. If ``False``, 'counterclockwise'
-        is assumed.
+        If positive directions are defined to be 'clockwise' (``True``) or 'counterclockwise'
+        (``False``). Clockwise means that the directions follow the right-hand rule
+        with an axis pointing downwards.
     waves_coming_from : bool
         If waves are 'coming from' the given directions. If ``False``, 'going towards'
         convention is assumed.
@@ -501,8 +502,9 @@ def set_wave_convention(self, clockwise=True, waves_coming_from=True):
         Parameters
         ----------
         clockwise : bool
-            If positive directions are defined to be 'clockwise'. If ``False``,
-            'counterclockwise' is assumed.
+            If positive directions are defined to be 'clockwise' (``True``) or
+            'counterclockwise' (``False``). Clockwise means that the directions
+            follow the right-hand rule with an axis pointing downwards.
         waves_coming_from : bool
             If waves are 'coming from' the given directions. If ``False``, 'going towards'
             convention is assumed.
@@ -939,8 +941,9 @@ class RAO(Grid):
     degrees : bool
         If direction is given in 'degrees'. If ``False``, 'radians' is assumed.
     clockwise : bool
-        If positive directions are defined to be 'clockwise'. If ``False``, 'counterclockwise'
-        is assumed.
+        If positive directions are defined to be 'clockwise' (``True``) or 'counterclockwise'
+        (``False``). Clockwise means that the directions follow the right-hand rule
+        with an axis pointing downwards.
     waves_coming_from : bool
         If waves are 'coming from' the given directions. If ``False``, 'going towards'
         convention is assumed.
@@ -1174,8 +1177,9 @@ class DirectionalSpectrum(DisableComplexMixin, Grid):
     degrees : bool
         If direction is given in 'degrees'. If ``False``, 'radians' is assumed.
     clockwise : bool
-        If positive directions are defined to be 'clockwise'. If ``False``, 'counterclockwise'
-        is assumed.
+        If positive directions are defined to be 'clockwise' (``True``) or 'counterclockwise'
+        (``False``). Clockwise means that the directions follow the right-hand rule
+        with an axis pointing downwards.
     waves_coming_from : bool
         If waves are 'coming from' the given directions. If ``False``, 'going towards'
         convention is assumed.