Skip to content

Commit 588391f

Browse files
committed
(pgr_findCloseEdges) promotion to official
(cherry picked from commit a02e055)
1 parent 513fc33 commit 588391f

File tree

5 files changed

+43
-41
lines changed

5 files changed

+43
-41
lines changed

NEWS.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,13 @@ milestone for 4.0.0
102102
* Error messages adjustment.
103103
* Function promoted to official.
104104

105-
**Changes on proposed functions**
106-
107105
* pgr_findCloseEdges
108106

109107
* Error messages adjustment.
110108
* ``partial`` option is removed.
109+
* Function promoted to official.
110+
111+
**Changes on proposed functions**
111112

112113
* pgr_degree
113114

@@ -184,7 +185,7 @@ milestone for 3.7.0
184185

185186
**Official functions changes**
186187

187-
* [#2605](https://github.com/pgRouting/pgrouting/pull/2605) Standarize
188+
* [#2605](https://github.com/pgRouting/pgrouting/pull/2605) Standardize
188189
spanning tree functions output
189190

190191
* Functions:
@@ -296,26 +297,26 @@ milestone for 3.6.0
296297

297298
**Official functions changes**
298299

299-
* [#2516](https://github.com/pgRouting/pgrouting/pull/2516) Standarize output
300+
* [#2516](https://github.com/pgRouting/pgrouting/pull/2516) Standardize output
300301
pgr_aStar
301302

302-
* Standarizing output columns to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
303+
* Standardize output columns to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
303304

304305
* pgr_aStar(One to One) added ``start_vid`` and ``end_vid`` columns.
305306
* pgr_aStar(One to Many) added ``end_vid`` column.
306307
* pgr_aStar(Many to One) added ``start_vid`` column.
307308

308-
* [#2523](https://github.com/pgRouting/pgrouting/pull/2523) Standarize output
309+
* [#2523](https://github.com/pgRouting/pgrouting/pull/2523) Standardize output
309310
pgr_bdAstar
310311

311-
* Standarizing output columns to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
312+
* Standardize output columns to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
312313

313314
* pgr_bdAstar(One to One) added ``start_vid`` and ``end_vid``
314315
columns.
315316
* pgr_bdAstar(One to Many) added ``end_vid`` column.
316317
* pgr_bdAstar(Many to One) added ``start_vid`` column.
317318

318-
* [#2547](https://github.com/pgRouting/pgrouting/pull/2547) Standarize output
319+
* [#2547](https://github.com/pgRouting/pgrouting/pull/2547) Standardize output
319320
and modifying signature pgr_KSP
320321

321322
* Result columns standarized to: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
@@ -327,7 +328,7 @@ milestone for 3.6.0
327328
* pgr_ksp(Many to Many)
328329
* pgr_ksp(Combinations)
329330

330-
* [#2548](https://github.com/pgRouting/pgrouting/pull/2548) Standarize output
331+
* [#2548](https://github.com/pgRouting/pgrouting/pull/2548) Standardize output
331332
pgr_drivingDistance
332333

333334
* Standarizing output columns to ``(seq, depth, start_vid, pred, node, edge, cost, agg_cost)``
@@ -339,7 +340,7 @@ milestone for 3.6.0
339340

340341
**Proposed functions changes**
341342

342-
* [#2544](https://github.com/pgRouting/pgrouting/pull/2544) Standarize output
343+
* [#2544](https://github.com/pgRouting/pgrouting/pull/2544) Standardize output
343344
and modifying signature pgr_withPointsDD
344345

345346
* Signature change: ``driving_side`` parameter changed from named optional to
@@ -358,7 +359,7 @@ milestone for 3.6.0
358359
* pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)
359360
* pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)
360361

361-
* [#2546](https://github.com/pgRouting/pgrouting/pull/2546) Standarize output
362+
* [#2546](https://github.com/pgRouting/pgrouting/pull/2546) Standardize output
362363
and modifying signature pgr_withPointsKSP
363364

364365
* Standarizing output columns to ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
@@ -396,9 +397,9 @@ milestone for 3.6.0
396397
* [#2490](https://github.com/pgRouting/pgrouting/pull/2490) Automatic page
397398
history links.
398399

399-
* ..rubric:: SQL standarization
400+
* ..rubric:: Standardize SQL
400401

401-
* [#2555](https://github.com/pgRouting/pgrouting/pull/2555) standarize
402+
* [#2555](https://github.com/pgRouting/pgrouting/pull/2555) Standardize
402403
deprecated messages
403404
* On new internal function: do not use named parameters and default parameters.
404405

@@ -456,7 +457,7 @@ milestone for 3.5.0
456457

457458
* Dijkstra
458459

459-
* Standarizing output columns to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
460+
* Standardize output columns to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
460461

461462
* pgr_dijkstra(One to One) added ``start_vid`` and ``end_vid`` columns.
462463
* pgr_dijkstra(One to Many) added ``end_vid`` column.

doc/src/proposed.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,6 @@ Proposed Functions
130130
via-category
131131
withPoints-category
132132

133-
.. rubric:: Utilities Category
134-
135-
:doc:`pgr_findCloseEdges`
136-
137-
.. toctree::
138-
:hidden:
139-
140-
pgr_findCloseEdges
141-
142133
See Also
143134
-------------------------------------------------------------------------------
144135

doc/src/release_notes.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -143,14 +143,14 @@ pgRouting 3.8.0 Release Notes
143143
:start-after: Version 3.8.0
144144
:end-before: .. rubric
145145

146-
.. rubric:: Changes on proposed functions
147-
148146
* pgr_findCloseEdges
149147

150148
.. include:: pgr_findCloseEdges.rst
151149
:start-after: Version 3.8.0
152150
:end-before: .. rubric
153151

152+
.. rubric:: Changes on proposed functions
153+
154154
* pgr_degree
155155

156156
.. include:: pgr_degree.rst
@@ -236,7 +236,7 @@ milestone for 3.7.0
236236

237237
.. rubric:: Official functions changes
238238

239-
* `#2605 <https://github.com/pgRouting/pgrouting/pull/2605>`__ Standarize
239+
* `#2605 <https://github.com/pgRouting/pgrouting/pull/2605>`__ Standardize
240240
spanning tree functions output
241241

242242
* Functions:
@@ -358,33 +358,33 @@ milestone for 3.6.0
358358

359359
.. rubric:: Official functions changes
360360

361-
* `#2516 <https://github.com/pgRouting/pgrouting/pull/2516>`__ Standarize output
361+
* `#2516 <https://github.com/pgRouting/pgrouting/pull/2516>`__ Standardize output
362362
pgr_aStar
363363

364-
* Standarizing output columns to |short-generic-result|
364+
* Standardize output columns to |short-generic-result|
365365

366366
* pgr_aStar(One to One) added ``start_vid`` and ``end_vid`` columns.
367367
* pgr_aStar(One to Many) added ``end_vid`` column.
368368
* pgr_aStar(Many to One) added ``start_vid`` column.
369369

370-
* `#2523 <https://github.com/pgRouting/pgrouting/pull/2523>`__ Standarize output
370+
* `#2523 <https://github.com/pgRouting/pgrouting/pull/2523>`__ Standardize output
371371
pgr_bdAstar
372372

373-
* Standarizing output columns to |short-generic-result|
373+
* Standardize output columns to |short-generic-result|
374374

375375
* pgr_bdAstar(One to One) added ``start_vid`` and ``end_vid``
376376
columns.
377377
* pgr_bdAstar(One to Many) added ``end_vid`` column.
378378
* pgr_bdAstar(Many to One) added ``start_vid`` column.
379379

380-
* `#2547 <https://github.com/pgRouting/pgrouting/pull/2547>`__ Standarize output
380+
* `#2547 <https://github.com/pgRouting/pgrouting/pull/2547>`__ Standardize output
381381
and modifying signature pgr_KSP
382382

383383
.. include:: pgr_KSP.rst
384384
:start-after: Version 3.6.0
385385
:end-before: .. rubric
386386

387-
* `#2548 <https://github.com/pgRouting/pgrouting/pull/2548>`__ Standarize output
387+
* `#2548 <https://github.com/pgRouting/pgrouting/pull/2548>`__ Standardize output
388388
pgr_drivingDistance
389389

390390
.. include:: pgr_drivingDistance.rst
@@ -393,14 +393,14 @@ milestone for 3.6.0
393393

394394
.. rubric:: Proposed functions changes
395395

396-
* `#2544 <https://github.com/pgRouting/pgrouting/pull/2544>`__ Standarize output
396+
* `#2544 <https://github.com/pgRouting/pgrouting/pull/2544>`__ Standardize output
397397
and modifying signature pgr_withPointsDD
398398

399399
.. include:: pgr_withPointsDD.rst
400400
:start-after: Version 3.6.0
401401
:end-before: .. rubric
402402

403-
* `#2546 <https://github.com/pgRouting/pgrouting/pull/2546>`__ Standarize output
403+
* `#2546 <https://github.com/pgRouting/pgrouting/pull/2546>`__ Standardize output
404404
and modifying signature pgr_withPointsKSP
405405

406406
.. include:: pgr_withPointsKSP.rst
@@ -429,9 +429,9 @@ milestone for 3.6.0
429429
* `#2490 <https://github.com/pgRouting/pgrouting/pull/2490>`__ Automatic page
430430
history links.
431431

432-
* ..rubric:: SQL standarization
432+
* ..rubric:: Standardize SQL
433433

434-
* `#2555 <https://github.com/pgRouting/pgrouting/pull/2555>`__ standarize
434+
* `#2555 <https://github.com/pgRouting/pgrouting/pull/2555>`__ Standardize
435435
deprecated messages
436436
* On new internal function: do not use named parameters and default parameters.
437437

@@ -495,7 +495,7 @@ milestone for 3.5.0
495495

496496
* Dijkstra
497497

498-
* Standarizing output columns to |short-generic-result|
498+
* Standardize output columns to |short-generic-result|
499499

500500
* pgr_dijkstra(One to One) added ``start_vid`` and ``end_vid`` columns.
501501
* pgr_dijkstra(One to Many) added ``end_vid`` column.

doc/src/routingFunctions.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ Function Families
9797

9898
:doc:`pgr_trsp` - Turn Restriction Shortest Path (TRSP)
9999

100+
.. rubric:: Utilities family
101+
102+
:doc:`pgr_findCloseEdges`
103+
104+
.. toctree::
105+
:hidden:
106+
107+
100108

101109
Functions by categories
102110
===============================================================================
@@ -162,6 +170,7 @@ Functions by categories
162170
reference
163171
topology-functions
164172
TSP-family
173+
pgr_findCloseEdges
165174

166175
.. toctree::
167176
:hidden:

doc/utilities/pgr_findCloseEdges.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
****************************************************************************
99

1010
.. index::
11-
single: Utilities ; pgr_findCloseEdges - Proposed
11+
single: Utilities ; pgr_findCloseEdges
1212
single: findCloseEdges
1313

1414
|
1515
16-
``pgr_findCloseEdges`` - Proposed
16+
``pgr_findCloseEdges``
1717
===============================================================================
1818

1919
``pgr_findCloseEdges`` - Finds the close edges to a point geometry.
@@ -24,6 +24,7 @@
2424

2525
* Error messages adjustment.
2626
* ``partial`` option is removed.
27+
* Function promoted to official.
2728

2829
.. rubric:: Version 3.4.0
2930

@@ -58,7 +59,7 @@ Signatures
5859
| OR EMPTY SET
5960
6061
.. index::
61-
single: findCloseEdges - Proposed ; One point - Proposed on 3.6
62+
single: findCloseEdges ; One point
6263

6364
One point
6465
...............................................................................
@@ -81,7 +82,7 @@ One point
8182
:end-before: -- q2
8283

8384
.. index::
84-
single: findCloseEdges - Proposed ; Many points - Proposed on 3.6
85+
single: findCloseEdges ; Many points
8586

8687
Many points
8788
...............................................................................

0 commit comments

Comments
 (0)