From 964916c75762c63bc7d189c24a7520b957729815 Mon Sep 17 00:00:00 2001 From: cvvergara Date: Wed, 22 Jan 2025 18:16:34 -0600 Subject: [PATCH] (doc) documentation of the changes --- NEWS.md | 31 ++++++++++++++++++++++++++----- doc/src/release_notes.rst | 31 ++++++++++++++++++++++++++----- 2 files changed, 52 insertions(+), 10 deletions(-) diff --git a/NEWS.md b/NEWS.md index a648eea186..54453687d7 100644 --- a/NEWS.md +++ b/NEWS.md @@ -41,15 +41,36 @@ milestone for 4.0.0 * pgr_maxFlow(Combinations) * pgr_pushRelabel(Combinations) +**code enhancements:** -**Removal of deprecated functions and signatures** +* Simplify C/C++ code for all overloads of -* ``pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text)`` -* ``pgr_trspviavertices(text,anyarray,boolean,boolean,text)`` -* ``pgr_trsp(text,integer,double precision,integer,double precision,boolean,boolean,text)`` -* ``pgr_trsp(text,integer,integer,boolean,boolean,text)`` + * pgr_dijkstra + +**Removal of SQL deprecated functions and signatures** + +* pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text) +* pgr_trspviavertices(text,anyarray,boolean,boolean,text) +* pgr_trsp(text,integer,double precision,integer,double precision,boolean,boolean,text) +* pgr_trsp(text,integer,integer,boolean,boolean,text) +* _pgr_dijkstranear(text,anyarray,anyarray,bigint,boolean) +* _pgr_dijkstranear(text,anyarray,bigint,bigint,boolean) +* _pgr_dijkstranear(text,bigint,anyarray,bigint,boolean) +* _pgr_dijkstra(text,anyarray,anyarray,boolean,boolean,boolean,bigint) +* _pgr_dijkstra(text,text,boolean,boolean,boolean) + +**Deprecation of internal C/C++ functions** + +* _pgr_dijkstra(text,anyarray,anyarray,boolean,boolean,boolean,bigint)`` +* _pgr_dijkstra(text,anyarray,anyarray,boolean,boolean,boolean,bigint,boolean)`` +* _pgr_dijkstra(text,text,boolean,boolean,bigint,boolean)`` +* _pgr_dijkstra(text,text,boolean,boolean,boolean)`` +**Internal C/C++ functions in legacy** +* _trsp(text,text,anyarray,anyarray,boolean)`` +* _v4trsp(text,text,anyarray,anyarray,boolean)`` +* _v4trsp(text,text,text,boolean)`` # pgRouting 3 diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst index d67ab3fe1f..2004ac9814 100644 --- a/doc/src/release_notes.rst +++ b/doc/src/release_notes.rst @@ -72,15 +72,36 @@ milestone for 4.0.0 * pgr_maxFlow(Combinations) * pgr_pushRelabel(Combinations) +.. rubric:: code enhancements: -.. rubric:: Removal of deprecated functions and signatures +* Simplify C/C++ code for all overloads of -* ``pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text)`` -* ``pgr_trspviavertices(text,anyarray,boolean,boolean,text)`` -* ``pgr_trsp(text,integer,double precision,integer,double precision,boolean,boolean,text)`` -* ``pgr_trsp(text,integer,integer,boolean,boolean,text)`` + * pgr_dijkstra + +.. rubric:: Removal of SQL deprecated functions and signatures + +* pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text) +* pgr_trspviavertices(text,anyarray,boolean,boolean,text) +* pgr_trsp(text,integer,double precision,integer,double precision,boolean,boolean,text) +* pgr_trsp(text,integer,integer,boolean,boolean,text) +* _pgr_dijkstranear(text,anyarray,anyarray,bigint,boolean) +* _pgr_dijkstranear(text,anyarray,bigint,bigint,boolean) +* _pgr_dijkstranear(text,bigint,anyarray,bigint,boolean) +* _pgr_dijkstra(text,anyarray,anyarray,boolean,boolean,boolean,bigint) +* _pgr_dijkstra(text,text,boolean,boolean,boolean) + +.. rubric:: Deprecation of internal C/C++ functions + +* _pgr_dijkstra(text,anyarray,anyarray,boolean,boolean,boolean,bigint)`` +* _pgr_dijkstra(text,anyarray,anyarray,boolean,boolean,boolean,bigint,boolean)`` +* _pgr_dijkstra(text,text,boolean,boolean,bigint,boolean)`` +* _pgr_dijkstra(text,text,boolean,boolean,boolean)`` +.. rubric:: Internal C/C++ functions in legacy +* _trsp(text,text,anyarray,anyarray,boolean)`` +* _v4trsp(text,text,anyarray,anyarray,boolean)`` +* _v4trsp(text,text,text,boolean)`` pgRouting 3 *******************************************************************************