Deprecating pgr AlphaShape

- Remove use on doc, docqueires, pgtap
- (doc) documenting changes on NEWS and release notes

(cherry picked from commit a9441ae)

Author: cvvergara

NEWS.md

@@ -124,6 +124,8 @@ milestone for 3.8.0
 
 **Deprecation of functions.**
 
+* [#2749](https://github.com/pgRouting/pgrouting/issues/2749):
+  pgr_alphaShape
 * [#2754](https://github.com/pgRouting/pgrouting/issues/2754):
   pgr_analyzeOneWay
 * [#2753](https://github.com/pgRouting/pgrouting/issues/2753):

doc/_static/page_history.js

@@ -261,7 +261,7 @@ var filesArr = [
     ]),
     new createInfo('pgr_alphaShape', '2.0', [
         { v: '2.1', n: 'src/driving_distance/doc/dd_alphashape'},
-        { v: '2.3', n: 'src/alpha_shape/doc/pgr_alphaShape'}
+        { v: '2.3', n: 'src/alpha_shape/doc/pgr_alphaShape'}, 3.8
     ]),
 
 ];

doc/alpha_shape/pgr_alphaShape.rst

@@ -20,6 +20,10 @@
 
 .. rubric:: Availability
 
+* Version 3.8.0
+
+  * Deprecated function.
+
 * Version 3.0.0
 
   * Breaking change on signature
@@ -39,7 +43,10 @@
   * New official function.
   * Renamed from version 1.x
 
-.. rubric:: Support
+
+.. include:: migration.rst
+   :start-after: migrate_pgr_alphaShape_start
+   :end-before: migrate_pgr_alphaShape_end
 
 Description
 -------------------------------------------------------------------------------

doc/driving_distance/pgr_drivingDistance.rst

@@ -177,7 +177,6 @@ Additional Examples
 See Also
 -------------------------------------------------------------------------------
 
-* :doc:`pgr_alphaShape` - Alpha shape computation
 * :doc:`sampledata`
 
 .. rubric:: Indices and tables

doc/src/migration.rst

@@ -24,6 +24,36 @@ Results can be different because of the changes.
 .. contents:: Contents
    :depth: 2
 
+.. migrate_pgr_alphaShape_start
+
+Migration of ``pgr_alphaShape``
+-------------------------------------------------------------------------------
+
+Starting from `v3.8.0 <https://docs.pgrouting.org/3.8/en/migration.html>`__
+
+**Before Deprecation:** The following was calculated:
+
+* An alphaShape was calculated
+
+**After Deprecation:**
+
+PostGIS has two ways of generating alphaShape.
+
+If you have SFCGAL, which you can install using
+
+::
+
+  CREATE EXTENSION postgis_sfcgal
+
+* Since PostGIS 3.5+ use `CG_AlphaShape <https://postgis.net/docs/CG_AlphaShape.html>`__
+* For PostGIS 3.5+ use the old name ``ST_AlphaShape``
+
+Other PostGIS options are
+* `ST_ConvexHull <https://postgis.net/docs/ST_ConvexHull.html>`__
+* `ST_ConcaveHull <https://postgis.net/docs/ST_ConcaveHull.html>`__
+
+.. migrate_pgr_alphaShape_end
+
 .. migrate_pgr_createTopology_start
 
 Migration of ``pgr_createTopology``

doc/src/release_notes.rst

@@ -165,6 +165,8 @@ milestone for 3.8.0
 
 .. rubric:: Deprecation of functions.
 
+* `#2749 <https://github.com/pgRouting/pgrouting/issues/2749>`__:
+  pgr_alphaShape
 * `#2754 <https://github.com/pgRouting/pgrouting/issues/2754>`__:
   pgr_analyzeOneWay
 * `#2753 <https://github.com/pgRouting/pgrouting/issues/2753>`__:

doc/withPoints/pgr_withPointsDD.rst

@@ -267,7 +267,6 @@ See Also
 -------------------------------------------------------------------------------
 
 * :doc:`pgr_drivingDistance`
-* :doc:`pgr_alphaShape`
 * :doc:`sampledata`
 
 .. rubric:: Indices and tables

docqueries/alpha_shape/alphashape.result

@@ -5,6 +5,7 @@ SET
 /* -- q1 */
 SELECT ST_Area(pgr_alphaShape((SELECT ST_Collect(geom)
       FROM vertices), 1.5));
+WARNING:  pgr_alphashape(geometry,double precision) deprecated function on v3.8.0
  st_area
 ---------
     9.75

sql/alpha_shape/alphaShape.sql

@@ -40,6 +40,7 @@ geom      geometry;
 delauny_query   TEXT;
 
 BEGIN
+    RAISE WARNING 'pgr_alphashape(geometry,double precision) deprecated function on v3.8.0';
     delauny_query = format($$
         WITH
         original AS (
@@ -83,11 +84,4 @@ LANGUAGE plpgsql VOLATILE STRICT
 COST 100;
 
 COMMENT ON FUNCTION pgr_alphashape(geometry, FLOAT)
-IS 'pgr_alphaShape
-- Parameters
-	- An SQL with columns: geom
-- Optional Parameters
-	- alpha := 0
-- Documentation:
-    - ${PROJECT_DOC_LINK}/pgr_alphaShape.html
-';
+IS 'pgr_alphaShape deprecated function on v3.8.0';