Release tasks 2

doc/coloring/pgr_bipartite.rst

@@ -64,10 +64,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_bipartite(`Edges SQL`_)
+   | pgr_bipartite(`Edges SQL`_)
 
-    RETURNS SET OF (vertex_id, color_id)
-    OR EMPTY SET
+   | RETURNS SET OF |result-node-color|
+   | OR EMPTY SET
 
 :Example: When the graph is bipartite
 

doc/coloring/pgr_edgeColoring.rst

@@ -49,7 +49,6 @@ no two adjacent edges have the same color.
 
   - :loop free: no self-loops and no parallel edges.
 
-
 - Provides the color to be assigned to all the edges present in the graph.
 
 - At most :math:`\Delta + 1` colors are used, where :math:`\Delta` is the degree
@@ -59,9 +58,9 @@ no two adjacent edges have the same color.
     color more than the optimal for all others.
   - When the graph is bipartite
 
-     - the chromatic number :math:`x'(G)` (minimum number of
-       colors needed for proper edge coloring of graph)  is equal to the degree
-       :math:`\Delta + 1` of the graph, (:math:`x'(G) = \Delta`)
+    - the chromatic number :math:`x'(G)` (minimum number of
+      colors needed for proper edge coloring of graph)  is equal to the degree
+      :math:`\Delta + 1` of the graph, (:math:`x'(G) = \Delta`)
 
 - The algorithm tries to assign the least possible color to every edge.
 
@@ -70,10 +69,10 @@ no two adjacent edges have the same color.
 - The returned rows are ordered in ascending order of the edge identifier.
 - Efficient graph coloring is an NP-Hard problem, and therefore:
 
-   - In this implelentation the running time: :math:`O(|E|*|V|)`
+  - In this implelentation the running time: :math:`O(|E|*|V|)`
 
-     - where :math:`|E|` is the number of edges in the graph,
-     - :math:`|V|` is the number of vertices in the graph.
+    - where :math:`|E|` is the number of edges in the graph,
+    - :math:`|V|` is the number of vertices in the graph.
 
 Signatures
 ------------------------------------------------------------------------------
@@ -84,10 +83,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_edgeColoring(`Edges SQL`_)
+   | pgr_edgeColoring(`Edges SQL`_)
 
-    RETURNS SET OF (edge_id, color_id)
-    OR EMPTY SET
+   | RETURNS SET OF |result-edge-color|
+   | OR EMPTY SET
 
 :Example: Graph coloring of pgRouting :doc:`sampledata`
 

doc/coloring/pgr_sequentialVertexColoring.rst

@@ -74,10 +74,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_sequentialVertexColoring(`Edges SQL`_)
+   | pgr_sequentialVertexColoring(`Edges SQL`_)
 
-    RETURNS SET OF (vertex_id, color_id)
-    OR EMPTY SET
+   | RETURNS SET OF |result-node-color|
+   | OR EMPTY SET
 
 :Example: Graph coloring of pgRouting :doc:`sampledata`
 

doc/components/pgr_articulationPoints.rst

@@ -70,9 +70,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_articulationPoints(`Edges SQL`_)
-    RETURNS SET OF (node)
-    OR EMPTY SET
+   | pgr_articulationPoints(`Edges SQL`_)
+
+   | RETURNS SET OF |result-node|
+   | OR EMPTY SET
 
 :Example: The articulation points of the graph
 
@@ -105,7 +106,7 @@ Edges SQL
 Result Columns
 -------------------------------------------------------------------------------
 
-Returns set of ``(node)``
+Returns set of |result-node|
 
 .. list-table::
    :width: 81

doc/components/pgr_biconnectedComponents.rst

@@ -78,9 +78,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_biconnectedComponents(`Edges SQL`_)
-    RETURNS SET OF (seq, component, edge)
-    OR EMPTY SET
+   | pgr_biconnectedComponents(`Edges SQL`_)
+
+   | RETURNS SET OF |result-component-E|
+   | OR EMPTY SET
 
 :Example: The biconnected components of the graph
 
@@ -111,7 +112,7 @@ Edges SQL
 Result Columns
 -------------------------------------------------------------------------------
 
-Returns set of ``(seq, component, edge)``
+Returns set of |result-component-E|
 
 .. list-table::
    :width: 81

doc/components/pgr_bridges.rst

@@ -66,9 +66,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_bridges(`Edges SQL`_)
-    RETURNS SET OF (edge)
-    OR EMPTY SET
+   | pgr_bridges(`Edges SQL`_)
+
+   | RETURNS SET OF |result-edge|
+   | OR EMPTY SET
 
 :Example: The bridges of the graph
 
@@ -99,7 +100,7 @@ Edges SQL
 Result Columns
 -------------------------------------------------------------------------------
 
-Returns set of ``(edge)``
+Returns set of |result-edge|
 
 .. list-table::
    :width: 81

doc/components/pgr_connectedComponents.rst

@@ -75,10 +75,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_connectedComponents(`Edges SQL`_)
+   | pgr_connectedComponents(`Edges SQL`_)
 
-    RETURNS SET OF (seq, component, node)
-    OR EMPTY SET
+   | RETURNS SET OF |result-component-V|
+   | OR EMPTY SET
 
 :Example: The connected components of the graph
 
@@ -112,7 +112,7 @@ Result Columns
 
 .. return_componentsV_start
 
-Returns set of ``(seq, component, node)``
+Returns set of |result-component-V|
 
 .. list-table::
    :width: 81

doc/components/pgr_makeConnected.rst

@@ -67,9 +67,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_makeConnected(`Edges SQL`_)
-    RETURNS SET OF (seq, start_vid, end_vid)
-    OR EMPTY SET
+   | pgr_makeConnected(`Edges SQL`_)
+
+   | RETURNS SET OF |result-component-make|
+   | OR EMPTY SET
 
 :Example: Query done on :doc:`sampledata` network gives the list of edges that
           are needed to connect the graph.
@@ -98,7 +99,7 @@ Edges SQL
 Result Columns
 -------------------------------------------------------------------------------
 
-Returns set of ``(seq, start_vid, end_vid)``
+Returns set of |result-component-make|
 
 .. list-table::
    :width: 81

doc/components/pgr_strongComponents.rst

@@ -73,9 +73,10 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_strongComponents(`Edges SQL`_)
-    RETURNS SET OF (seq, component, node)
-    OR EMPTY SET
+   | pgr_strongComponents(`Edges SQL`_)
+
+   | RETURNS SET OF |result-component-V|
+   | OR EMPTY SET
 
 :Example: The strong components of the graph
 

doc/conf.py.in

@@ -333,7 +333,7 @@ linkcheck_ignore = [
     r'https://docs.pgrouting.org/.*/.*/DFS-category.html',
     r'https://docs.pgrouting.org/.*/.*/reference.html',
     r'https://docs.pgrouting.org/.*/.*/pgr_degree.html',
-    r'https://docs.pgrouting.org/.*/.*/cuthillMckeeOrdering.html',
+    r'https://docs.pgrouting.org/.*/.*/pgr_cuthillMckeeOrdering.html',
     r'https://docs.pgrouting.org/.*/.*/ordering-family.html',
     r'https://docs.pgrouting.org/.*/.*/hawickCircuits.html',
     r'https://docs.pgrouting.org/.*/.*/pgr_findCloseEdges.html',
@@ -356,6 +356,8 @@ rst_epilog="""
 .. |ANY-INTEGER| replace:: :abbr:`ANY-INTEGER(SMALLINT, INTEGER, BIGINT)`
 .. |ANY-NUMERICAL| replace:: :abbr:`ANY-NUMERICAL(SMALLINT, INTEGER, BIGINT, REAL, FLOAT)`
 .. |generic-result| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
+.. |ksp-result| replace:: ``(seq, path_id, path_seq, node, edge, cost, agg_cost)``
+.. |short-generic-result| replace:: ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 .. |via-result| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost, route_agg_cost)``
 .. |matrix-result| replace:: ``(start_vid, end_vid, agg_cost)``
 .. |old-generic-result| replace:: ``(seq, path_seq, [start_vid], [end_vid], node, edge, cost, agg_cost)``
@@ -364,7 +366,32 @@ rst_epilog="""
 .. |result-m-1| replace:: ``(seq, path_seq, start_vid, node, edge, cost, agg_cost)``
 .. |result-m-m| replace:: ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
 .. |result-bfs| replace:: ``(seq, depth, start_vid, node, edge, cost, agg_cost)``
+.. |result-mst| replace:: ``(edge, cost)``
 .. |result-1-1-no-seq| replace:: ``(seq, node, edge, cost, agg_cost)``
+.. |result-node-color| replace:: ``(vertex_id, color_id)``
+.. |result-edge-color| replace:: ``(edge_id, color_id)``
+.. |result-node| replace:: ``(node)``
+.. |result-edge| replace:: ``(edge)``
+.. |result-node-order| replace:: ``(seq, node)``
+.. |result-toposort| replace:: ``(seq, sorted_v)``
+.. |result-closure| replace:: ``(seq, vid, target_array)``
+.. |result-component-E| replace:: ``(seq, component, edge)``
+.. |result-component-V| replace:: ``(seq, component, node)``
+.. |result-component-make| replace:: ``(seq, start_vid, end_vid)``
+.. |result-contract| replace:: ``(type, id, contracted_vertices, source, target, cost)``
+.. |result-idom| replace:: ``(seq, vertex_id, idom)``
+.. |result-dij-dd| replace:: ``(seq, [from_v,] node, edge, cost, agg_cost)``
+.. |result-dij-dd-m| replace:: ``(seq, from_v, node, edge, cost, agg_cost)``
+.. |result-linegf| replace:: ``(seq, source, target, cost, edge)``
+.. |result-lineg| replace:: ``(seq, source, target, cost, reverse_cost)``
+.. |result-flow| replace:: ``(seq, edge, start_vid, end_vid, flow, residual_capacity)``
+.. |result-flow-mincost| replace:: ``(seq, edge, source, target, flow, residual_capacity, cost, agg_cost)``
+.. |result-disjoint| replace:: ``(seq, path_id, path_seq, [start_vid,] [end_vid,] node, edge, cost, agg_cost)``
+.. |result-disjoint-1-1| replace:: ``(seq, path_id, path_seq, node, edge, cost, agg_cost)``
+.. |result-disjoint-1-m| replace:: ``(seq, path_id, path_seq, end_vid, node, edge, cost, agg_cost)``
+.. |result-disjoint-m-1| replace:: ``(seq, path_id, path_seq, start_vid, node, edge, cost, agg_cost)``
+.. |result-disjoint-m-m| replace:: ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
+.. |result-mincut| replace:: ``(seq, edge, cost, mincut)``
 
 """
 

doc/contraction/pgr_contraction.rst

@@ -91,9 +91,10 @@ The pgr_contraction function has the following signature:
 .. admonition:: \ \
    :class: signatures
 
-   | pgr_contraction(`Edges SQL`_, **contraction order**
-   |      [, max_cycles] [, forbidden_vertices] [, directed])
-   | RETURNS SETOF (type, id, contracted_vertices, source, target, cost)
+   | pgr_contraction(`Edges SQL`_, **contraction order**, [**options**])
+
+   | **options:** ``[ max_cycles, forbidden_vertices, directed]``
+   | RETURNS SET OF |result-contract|
 
 :Example: Making a dead end and linear contraction in that order on an
           undirected graph.
@@ -165,7 +166,7 @@ Edges SQL
 Result Columns
 -------------------------------------------------------------------------------
 
-RETURNS SETOF  (type, id, contracted_vertices, source, target, cost)
+Returns set of  |result-contract|
 
 The function returns a single row. The columns of the row are:
 

doc/dagShortestPath/pgr_dagShortestPath.rst

@@ -94,14 +94,14 @@ Signatures
 .. admonition:: \ \
    :class: signatures
 
-    pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vid**)
-    pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vids**)
-    pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**)
-    pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**)
-    pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_)
+   | pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vid**)
+   | pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vids**)
+   | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**)
+   | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**)
+   | pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_)
 
-    RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
-    OR EMPTY SET
+   | RETURNS SET OF |result-1-1|
+   | OR EMPTY SET
 
 
 .. index::
@@ -113,9 +113,10 @@ One to One
 .. admonition:: \ \
    :class: signatures
 
-    pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vid**)
-    RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
-    OR EMPTY SET
+   | pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vid**)
+
+   | RETURNS SET OF |result-1-1|
+   | OR EMPTY SET
 
 :Example: From vertex :math:`5` to vertex  :math:`11` on a **directed** graph
 
@@ -132,9 +133,10 @@ One to Many
 .. admonition:: \ \
    :class: signatures
 
-    pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vids**)
-    RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
-    OR EMPTY SET
+   | pgr_dagShortestPath(`Edges SQL`_, **start vid**,  **end vids**)
+
+   | RETURNS SET OF |result-1-1|
+   | OR EMPTY SET
 
 :Example: From vertex :math:`5` to vertices :math:`\{7, 11\}`
 
@@ -151,9 +153,10 @@ Many to One
 .. admonition:: \ \
    :class: signatures
 
-    pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**)
-    RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
-    OR EMPTY SET
+   | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**)
+
+   | RETURNS SET OF |result-1-1|
+   | OR EMPTY SET
 
 :Example: From vertices :math:`\{5, 10\}` to vertex :math:`11`
 
@@ -170,9 +173,10 @@ Many to Many
 .. admonition:: \ \
    :class: signatures
 
-    pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**)
-    RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
-    OR EMPTY SET
+   | pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**)
+
+   | RETURNS SET OF |result-1-1|
+   | OR EMPTY SET
 
 :Example: From vertices :math:`\{5, 15\}` to vertices :math:`\{11, 17\}` on an
           **undirected** graph
@@ -190,9 +194,10 @@ Combinations
 .. admonition:: \ \
    :class: signatures
 
-    pgr_dagShortestPath(`Edges SQL`_, Combinations)
-    RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
-    OR EMPTY SET
+   | pgr_dagShortestPath(`Edges SQL`_, Combinations)
+
+   | RETURNS SET OF |result-1-1|
+   | OR EMPTY SET
 
 :Example: Using a combinations table on an **undirected** graph