From 8c3a7e5b6ecee7e7b8c5a13de2f7ca0c9653136f Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 31 Jan 2024 10:30:55 -0700 Subject: [PATCH] Update documentation of a function slightly. --- include/aspect/utilities.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/aspect/utilities.h b/include/aspect/utilities.h index aafaf1d3e23..0aa05e26564 100644 --- a/include/aspect/utilities.h +++ b/include/aspect/utilities.h @@ -383,10 +383,10 @@ namespace aspect WGS84_coordinates(const dealii::Point &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 std::array