Explicitly mention that mild canonical form is not meant to be stable

shapely · Feb 24, 2024 · 0ef9455 · 0ef9455
1 parent 100d877
commit 0ef9455
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/docs/geometry.rst b/docs/geometry.rst
@@ -181,7 +181,8 @@ Canonical form
 When operations are applied on geometries the result is returned according to some
 conventions.
 
-In most cases, geometries will be returned in "mild" canonical form:
+In most cases, geometries will be returned in "mild" canonical form. There is no goal
+to keep this form stable, so it is expected to change in future versions of GEOS:
 
 - the coordinates of exterior rings follow a clockwise orientation and interior
   rings have a counter-clockwise orientation. This is the opposite of the OGC
@@ -190,7 +191,9 @@ In most cases, geometries will be returned in "mild" canonical form:
 - the order of geometry types in a collection can be changed, but the order is
   undefined
 
-When :func:`~shapely.normalize` is used, the "strict" canonical form is applied:
+When :func:`~shapely.normalize` is used, the "strict" canonical form is applied. This
+type of normalization is meant to be stable, so changes to it will be avoided if
+possible:
 
 - the coordinates of exterior rings follow a clockwise orientation and interior
   rings have a counter-clockwise orientation