Further clarify CRS' hasAxisInverted

Thanks to @pathmapper & @nyalldawson
qgis · Jun 8, 2023 · 6a14504 · 6a14504
1 parent f43e51d
commit 6a14504
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in b/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
@@ -915,9 +915,12 @@ the projection method used by the CRS.
 
     bool hasAxisInverted() const;
 %Docstring
-Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS.
+Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/latitude).
+E.g. with WMS 1.3 the axis order for EPSG:4326 is north/east (latitude/longitude), i.e. inverted.
 
 :return: ``True`` if CRS axis is inverted
+
+.. seealso:: :py:func:`axisOrdering`
 %End
 
     SIP_PYOBJECT axisOrdering() const /TypeHint="List[Qgis.CrsAxisDirection]"/;

diff --git a/src/core/proj/qgscoordinatereferencesystem.h b/src/core/proj/qgscoordinatereferencesystem.h
@@ -836,7 +836,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
     QgsProjOperation operation() const;
 
     /**
-     * Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS, i.e. if "north" is the first axis, instead of "east".
+     * Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/latitude).
+     * E.g. with WMS 1.3 the axis order for EPSG:4326 is north/east (latitude/longitude), i.e. inverted.
      * \returns TRUE if CRS axis is inverted
      *
      * \see axisOrdering()