Improve docs

qgis · Nov 2, 2021 · 4b7dff6 · 4b7dff6
1 parent 515fa62
commit 4b7dff6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -384,6 +384,8 @@ Returns the planar, 2-dimensional area of the geometry.
 %Docstring
 Returns the planar, 2-dimensional length of geometry.
 
+If the geometry is a polygon geometry then the perimeter of the polygon will be returned.
+
 .. warning::
 
    QgsGeometry objects are inherently Cartesian/planar geometries, and the length

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -419,6 +419,8 @@ class CORE_EXPORT QgsGeometry
     /**
      * Returns the planar, 2-dimensional length of geometry.
      *
+     * If the geometry is a polygon geometry then the perimeter of the polygon will be returned.
+     *
      * \warning QgsGeometry objects are inherently Cartesian/planar geometries, and the length
      * returned by this method is calculated using strictly Cartesian mathematics. In contrast,
      * the QgsDistanceArea class exposes methods for calculating the lengths of geometries using