Merge pull request #5557 from bangerth/doc

Update documentation of a function slightly.
geodynamics · Feb 2, 2024 · 4064661 · 4064661
2 parents 7654e7b + 8c3a7e5
commit 4064661
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/include/aspect/utilities.h b/include/aspect/utilities.h
@@ -383,10 +383,10 @@ namespace aspect
       WGS84_coordinates(const dealii::Point<dim> &position);
 
       /**
-       * Returns spherical coordinates of a Cartesian point. The returned array
-       * is filled with radius, phi and theta (polar angle). If the dimension is
-       * set to 2 theta is omitted. Phi is always normalized to [0,2*pi].
-       *
+       * Returns spherical coordinates of a Cartesian point. If `dim==3`, then
+       * the returned array contains the three values radius, phi and theta
+       * (polar angle). If `dim==2`, then theta is omitted.
+       * Phi is always normalized to [0,2*pi].
        */
       template <int dim>
       std::array<double,dim>