[doc] verify DOC where the index mentions when it was added as experi…

…mental or proposed
pgRouting · Nov 10, 2021 · b90e776 · b90e776
1 parent 0523203
commit b90e776
Show file tree

Hide file tree

Showing 50 changed files with 197 additions and 146 deletions.
diff --git a/doc/astar/pgr_aStar.rst b/doc/astar/pgr_aStar.rst
@@ -93,7 +93,7 @@ Signatures
     pgr_aStar(Edges SQL, from_vid,  to_vids [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_aStar(Edges SQL, from_vids, to_vid  [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_aStar(Edges SQL, from_vids, to_vids [, directed] [, heuristic] [, factor] [, epsilon])
-    pgr_aStar(Edges SQL, Combinations SQL  [, directed] [, heuristic] [, factor] [, epsilon]) -- Proposed on v3.2
+    pgr_aStar(Edges SQL, Combinations SQL  [, directed] [, heuristic] [, factor] [, epsilon])
 
     RETURNS SET OF (seq, path_seq [, start_vid] [, end_vid], node, edge, cost, agg_cost)
     OR EMPTY SET
@@ -188,7 +188,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: aStar(Combinations) -- Proposed on v3.2
+    single: aStar(Combinations) - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/astar/pgr_aStarCost.rst b/doc/astar/pgr_aStarCost.rst
@@ -73,7 +73,7 @@ Signatures
     pgr_aStarCost(Edges SQL, from_vid,  to_vids  [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_aStarCost(Edges SQL, from_vids, to_vid   [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_aStarCost(Edges SQL, from_vids, to_vids  [, directed] [, heuristic] [, factor] [, epsilon])
-    pgr_aStarCost(Edges SQL, Combinations SQL  [, directed] [, heuristic] [, factor] [, epsilon]) -- Proposed on v3.2
+    pgr_aStarCost(Edges SQL, Combinations SQL  [, directed] [, heuristic] [, factor] [, epsilon])
 
     RETURNS SET OF (start_vid, end_vid, agg_cost)
     OR EMPTY SET
@@ -167,7 +167,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: aStarCost(Combinations) -- Proposed on v3.2
+    single: aStarCost(Combinations) - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdAstar/pgr_bdAstar.rst b/doc/bdAstar/pgr_bdAstar.rst
@@ -91,7 +91,7 @@ Signature
     pgr_bdAstar(Edges SQL, from_vid,  to_vids  [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_bdAstar(Edges SQL, from_vids, to_vid   [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_bdAstar(Edges SQL, from_vids, to_vids  [, directed] [, heuristic] [, factor] [, epsilon])
-    pgr_bdAstar(Edges SQL, Combinations SQL  [, directed] [, heuristic] [, factor] [, epsilon]) -- Proposed on v3.2
+    pgr_bdAstar(Edges SQL, Combinations SQL  [, directed] [, heuristic] [, factor] [, epsilon])
 
     RETURNS SET OF (seq, path_seq [, start_vid] [, end_vid], node, edge, cost, agg_cost)
     OR EMPTY SET
@@ -182,7 +182,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: bdAstar(Combinations) -- Proposed on v3.2
+    single: bdAstar(Combinations) - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdAstar/pgr_bdAstarCost.rst b/doc/bdAstar/pgr_bdAstarCost.rst
@@ -70,7 +70,7 @@ Signatures
     pgr_bdAstarCost(Edges SQL, from_vid,  to_vids [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_bdAstarCost(Edges SQL, from_vids, to_vid  [, directed] [, heuristic] [, factor] [, epsilon])
     pgr_bdAstarCost(Edges SQL, from_vids, to_vids [, directed] [, heuristic] [, factor] [, epsilon])
-    pgr_bdAstarCost(Edges SQL, Combinations SQL [, directed] [, heuristic] [, factor] [, epsilon]) -- Proposed on v3.2
+    pgr_bdAstarCost(Edges SQL, Combinations SQL [, directed] [, heuristic] [, factor] [, epsilon])
 
     RETURNS SET OF (start_vid, end_vid, agg_cost)
     OR EMPTY SET
@@ -164,7 +164,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: bdAstarCost(Combinations) -- Proposed on v3.2
+    single: bdAstarCost(Combinations) - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdDijkstra/pgr_bdDijkstra.rst b/doc/bdDijkstra/pgr_bdDijkstra.rst
@@ -87,7 +87,7 @@ Signatures
     pgr_bdDijkstra(Edges SQL, start_vid,  end_vids [, directed])
     pgr_bdDijkstra(Edges SQL, start_vids, end_vid  [, directed])
     pgr_bdDijkstra(Edges SQL, start_vids, end_vids [, directed])
-    pgr_bdDijkstra(Edges SQL, Combinations SQL [, directed]) -- Proposed on v3.2
+    pgr_bdDijkstra(Edges SQL, Combinations SQL [, directed])
 
     RETURNS SET OF (seq, path_seq [, start_vid] [, end_vid], node, edge, cost, agg_cost)
     OR EMPTY SET
@@ -179,7 +179,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: bdDijkstra(Combinations) -- Proposed on v3.2
+    single: bdDijkstra(Combinations) - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdDijkstra/pgr_bdDijkstraCost.rst b/doc/bdDijkstra/pgr_bdDijkstraCost.rst
@@ -66,7 +66,7 @@ Signatures
     pgr_bdDijkstraCost(Edges SQL, from_vid,  to_vids [, directed])
     pgr_bdDijkstraCost(Edges SQL, from_vids, to_vid  [, directed])
     pgr_bdDijkstraCost(Edges SQL, from_vids, to_vids [, directed])
-    pgr_bdDijkstraCost(Edges SQL, Combinations SQL [, directed]) -- Proposed on v3.2
+    pgr_bdDijkstraCost(Edges SQL, Combinations SQL [, directed])
 
     RETURNS SET OF (start_vid, end_vid, agg_cost)
     OR EMPTY SET
@@ -158,7 +158,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: bdDijkstraCost(Combinations) -- Proposed on v3.2
+    single: bdDijkstraCost(Combinations) - Proposed on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst b/doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst
@@ -63,7 +63,7 @@ Signatures
     RETURNS SET OF (start_vid, end_vid, agg_cost)
 
 .. index::
-    single: bdDijkstraCostMatrix(Minimal Use)
+    single: bdDijkstraCostMatrix
 
 .. rubric:: Using default
 

diff --git a/doc/bellman_ford/pgr_bellmanFord.rst b/doc/bellman_ford/pgr_bellmanFord.rst
@@ -84,7 +84,7 @@ Signatures
     pgr_bellmanFord(Edges SQL, from_vid,  to_vids [, directed])
     pgr_bellmanFord(Edges SQL, from_vids, to_vid  [, directed])
     pgr_bellmanFord(Edges SQL, from_vids, to_vids [, directed])
-    pgr_bellmanFord(Edges SQL, Combinations SQL [, directed]) -- Experimental on v3.2
+    pgr_bellmanFord(Edges SQL, Combinations SQL [, directed])
 
     RETURNS SET OF (seq, path_seq, node, edge, cost, agg_cost)
     OR EMPTY SET
@@ -104,7 +104,7 @@ Signatures
    :end-before: -- q2
 
 .. index::
-    single: bellman_ford(One to One) - Experimental
+    single: bellman_ford(One to One) - Experimental on v3.0
 
 One to One
 ...............................................................................
@@ -122,7 +122,7 @@ One to One
    :end-before: -- q3
 
 .. index::
-    single: bellmanFord(One to Many) - Experimental
+    single: bellmanFord(One to Many) - Experimental on v3.0
 
 One to many
 ...............................................................................
@@ -140,7 +140,7 @@ One to many
    :end-before: -- q4
 
 .. index::
-    single: bellman_ford(Many to One) - Experimental
+    single: bellman_ford(Many to One) - Experimental on v3.0
 
 Many to One
 ...............................................................................
@@ -158,7 +158,7 @@ Many to One
    :end-before: -- q5
 
 .. index::
-    single: bellmanFord(Many to Many) - Experimental
+    single: bellmanFord(Many to Many) - Experimental on v3.0
 
 Many to Many
 ...............................................................................
@@ -176,7 +176,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: bellmanFord(Combinations) -- Experimental on v3.2
+    single: bellmanFord(Combinations) - Experimental on v3.2
 
 Combinations
 ...............................................................................
@@ -249,4 +249,3 @@ See Also
 
 * :ref:`genindex`
 * :ref:`search`
-
diff --git a/doc/bellman_ford/pgr_edwardMoore.rst b/doc/bellman_ford/pgr_edwardMoore.rst
@@ -99,7 +99,7 @@ Signatures
    :end-before: -- q2
 
 .. index::
-    single: edwardMoore(One to One) - Experimental
+    single: edwardMoore(One to One) - Experimental on v3.0
 
 One to One
 ...............................................................................
@@ -117,7 +117,7 @@ One to One
    :end-before: -- q3
 
 .. index::
-    single: edwardMoore(One to Many) - Experimental
+    single: edwardMoore(One to Many) - Experimental on v3.0
 
 One to many
 ...............................................................................
@@ -135,7 +135,7 @@ One to many
    :end-before: -- q4
 
 .. index::
-    single: edwardMoore(Many to One) - Experimental
+    single: edwardMoore(Many to One) - Experimental on v3.0
 
 Many to One
 ...............................................................................
@@ -153,7 +153,7 @@ Many to One
    :end-before: -- q5
 
 .. index::
-    single: edwardMoore(Many to Many) - Experimental
+    single: edwardMoore(Many to Many) - Experimental on v3.0
 
 Many to Many
 ...............................................................................
@@ -171,7 +171,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: edwardMoore(Combinations) -- Experimental on v3.2
+    single: edwardMoore(Combinations) - Experimental on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst b/doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst
@@ -13,7 +13,7 @@
   `Latest <https://docs.pgrouting.org/latest/en/pgr_binaryBreadthFirstSearch.html>`__
   (`3.3 <https://docs.pgrouting.org/3.3/en/pgr_binaryBreadthFirstSearch.html>`__)
   `3.2 <https://docs.pgrouting.org/3.2/en/pgr_binaryBreadthFirstSearch.html>`__
-  
+
 pgr_binaryBreadthFirstSearch - Experimental
 ===============================================================================
 
@@ -71,7 +71,7 @@ Signatures
     pgr_binaryBreadthFirstSearch(Edges SQL, start_vid,  end_vids [, directed])
     pgr_binaryBreadthFirstSearch(Edges SQL, start_vids, end_vid  [, directed])
     pgr_binaryBreadthFirstSearch(Edges SQL, start_vids, end_vids [, directed])
-    pgr_binaryBreadthFirstSearch(Edges SQL, Combinations SQL [, directed]) -- Proposed on v3.2
+    pgr_binaryBreadthFirstSearch(Edges SQL, Combinations SQL [, directed])
     RETURNS SET OF (seq, path_seq [, start_vid] [, end_vid], node, edge, cost, agg_cost)
     OR EMPTY SET
 
@@ -87,7 +87,7 @@ Signatures
    :end-before: -- q2
 
 .. index::
-    single: binaryBreadthFirstSearch(One to One) - Experimental
+    single: binaryBreadthFirstSearch(One to One) - Experimental on v3.0
 
 One to One
 ...............................................................................
@@ -105,7 +105,7 @@ One to One
    :end-before: -- q3
 
 .. index::
-    single: binaryBreadthFirstSearch(One to Many) - Experimental
+    single: binaryBreadthFirstSearch(One to Many) - Experimental on v3.0
 
 One to many
 ...............................................................................
@@ -123,7 +123,7 @@ One to many
    :end-before: -- q4
 
 .. index::
-    single: binaryBreadthFirstSearch(Many to One) - Experimental
+    single: binaryBreadthFirstSearch(Many to One) - Experimental on v3.0
 
 Many to One
 ...............................................................................
@@ -141,7 +141,7 @@ Many to One
    :end-before: -- q5
 
 .. index::
-    single: binaryBreadthFirstSearch(Many to Many) - Experimental
+    single: binaryBreadthFirstSearch(Many to Many) - Experimental on v3.0
 
 Many to Many
 ...............................................................................
@@ -159,7 +159,7 @@ Many to Many
    :end-before: -- q6
 
 .. index::
-    single: binaryBreadthFirstSearch(Combinations) -- Experimental on v3.2
+    single: binaryBreadthFirstSearch(Combinations) - Experimental on v3.2
 
 Combinations
 ...............................................................................

diff --git a/doc/breadthFirstSearch/pgr_breadthFirstSearch.rst b/doc/breadthFirstSearch/pgr_breadthFirstSearch.rst
@@ -13,7 +13,9 @@
   `Latest <https://docs.pgrouting.org/latest/en/pgr_breadthFirstSearch.html>`__
   (`3.3 <https://docs.pgrouting.org/3.3/en/pgr_breadthFirstSearch.html>`__)
   `3.2 <https://docs.pgrouting.org/3.2/en/pgr_breadthFirstSearch.html>`__
-
+  `3.1 <https://docs.pgrouting.org/3.1/en/pgr_breadthFirstSearch.html>`__
+  `3.0 <https://docs.pgrouting.org/3.0/en/pgr_breadthFirstSearch.html>`__
+
 pgr_breadthFirstSearch - Experimental
 ===============================================================================
 
@@ -30,6 +32,10 @@ pgr_breadthFirstSearch - Experimental
 
 .. rubric:: Availability
 
+* Version 3.0.0
+
+  * New **experimental** function:
+
 Description
 -------------------------------------------------------------------------------
 
@@ -52,7 +58,7 @@ Signatures
     RETURNS SET OF (seq, depth, start_vid, node, edge, cost, agg_cost)
 
 .. index::
-    single: breadthFirstSearch(Single vertex) - Experimental
+    single: breadthFirstSearch(Single vertex) - Experimental on v3.0
 
 Single Vertex
 ...............................................................................
@@ -70,7 +76,7 @@ Single Vertex
    :end-before: --q2
 
 .. index::
-    single: breadthFirstSearch(Multiple vertices) - Experimental
+    single: breadthFirstSearch(Multiple vertices) - Experimental on v3.0
 
 Multiple Vertices
 ...............................................................................

diff --git a/doc/chinese/pgr_chinesePostman.rst b/doc/chinese/pgr_chinesePostman.rst
@@ -46,7 +46,7 @@ Signatures
 -------------------------------------------------------------------------------
 
 .. index::
-    single: chinesePostman - Experimental
+    single: chinesePostman - Experimental on v3.0
 
 .. code-block:: none
 

diff --git a/doc/chinese/pgr_chinesePostmanCost.rst b/doc/chinese/pgr_chinesePostmanCost.rst
@@ -46,7 +46,7 @@ Signatures
 -------------------------------------------------------------------------------
 
 .. index::
-    single: chinesePostmanCost - Experimental
+    single: chinesePostmanCost - Experimental on v3.0
 
 .. code-block:: none
 

diff --git a/doc/coloring/pgr_bipartite.rst b/doc/coloring/pgr_bipartite.rst
@@ -52,10 +52,13 @@ A bipartite graph is possible if the graph coloring is possible using two colors
 Signatures
 -------------------------------------------------------------------------------
 
+.. index::
+    single: bipartite - Experimental on v3.2
+
 
 .. code-block:: sql
 
-    pgr_bipartite(Edges SQL) -- Experimental on v3.2
+    pgr_bipartite(Edges SQL)
 
     RETURNS SET OF (vertex_id, color_id)
     OR EMPTY SET
@@ -69,9 +72,6 @@ Signatures
    :end-before: --q2
 
 
-.. index::
-    single: bipartite (Single Vertex) - Experimental on v3.2
-
 
 .. Parameters, Inner query & result columns
 

diff --git a/doc/coloring/pgr_edgeColoring.rst b/doc/coloring/pgr_edgeColoring.rst
@@ -60,9 +60,12 @@ color.
 Signatures
 ------------------------------------------------------------------------------
 
+.. index::
+    single: edgeColoring - Experimental on v3.3
+
 .. code-block:: sql
 
-    pgr_edgeColoring(Edges SQL) -- Experimental on v3.3
+    pgr_edgeColoring(Edges SQL)
 
     RETURNS SET OF (edge_id, color_id)
     OR EMPTY SET
@@ -73,9 +76,6 @@ Signatures
    :start-after: -- q1
    :end-before: -- q2
 
-.. index::
-    single: edgeColoring -- Experimental on v3.3
-
 .. Parameters, Inner query & result columns
 
 Parameters