(doc) fixing some bugs

pgRouting · Feb 11, 2025 · 2a7a2e8 · 2a7a2e8
1 parent 4f14460
commit 2a7a2e8
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 32 deletions.
diff --git a/doc/astar/pgr_aStar.rst b/doc/astar/pgr_aStar.rst
@@ -289,7 +289,7 @@ See Also
 * :doc:`aStar-family`
 * :doc:`bdAstar-family`
 * :doc:`sampledata`
-* https://www.boost.org/libs/graph/doc/astar_search.html
+* `Boost: A* search <https://www.boost.org/libs/graph/doc/astar_search.html>`__
 * https://en.wikipedia.org/wiki/A*_search_algorithm
 
 .. rubric:: Indices and tables

diff --git a/doc/bdAstar/bdAstar-family.rst b/doc/bdAstar/bdAstar-family.rst
@@ -62,7 +62,7 @@ See Also
 -------------------------------------------------------------------------------
 
 * :doc:`aStar-family`
-* `Boost <https://www.boost.org/libs/graph/doc/astar_search.html>`__
+* `Boost: A* search <https://www.boost.org/libs/graph/doc/astar_search.html>`__
 * https://en.wikipedia.org/wiki/A*_search_algorithm
 
 .. rubric:: Indices and tables

diff --git a/doc/components/pgr_biconnectedComponents.rst b/doc/components/pgr_biconnectedComponents.rst
@@ -25,8 +25,8 @@
 
   * Result columns change:
 
-    * n_seq`` is removed
-    * seq`` changed type to ``BIGINT``
+    * ``n_seq`` is removed
+    * ``seq`` changed type to ``BIGINT``
 
   * Function promoted to official.
 

diff --git a/doc/components/pgr_connectedComponents.rst b/doc/components/pgr_connectedComponents.rst
@@ -25,8 +25,8 @@ a DFS-based approach.
 
   * Result columns change:
 
-    * n_seq`` is removed
-    * seq`` changed type to ``BIGINT``
+    * ``n_seq`` is removed
+    * ``seq`` changed type to ``BIGINT``
 
   * Function promoted to official.
 

diff --git a/doc/dijkstra/pgr_dijkstra.rst b/doc/dijkstra/pgr_dijkstra.rst
@@ -600,7 +600,7 @@ The following examples find the path for :math:`\{6\}\rightarrow\{10\}`
    :start-after: -- q154
    :end-before: -- q16
 
-e Also
+See Also
 -------------------------------------------------------------------------------
 
 * :doc:`sampledata`

diff --git a/doc/max_flow/pgr_maxCardinalityMatch.rst b/doc/max_flow/pgr_maxCardinalityMatch.rst
@@ -28,13 +28,13 @@ graph.
   * Works for undirected graphs.
   * New signature
 
-    * pgr_maxCardinalityMatch(text)`` returns only ``edge`` column.
+    * pgr_maxCardinalityMatch(text) returns only ``edge`` column.
 
   * Deprecated signature
 
-    * pgr_maxCardinalityMatch(text,boolean)``
+    * pgr_maxCardinalityMatch(text,boolean)
 
-      * directed => false`` when used.
+      * directed => ``false`` when used.
 
 * Version 3.0.0
 

diff --git a/doc/src/migration.rst b/doc/src/migration.rst
@@ -782,7 +782,7 @@ Signature:
 .. contents::
    :local:
 
-.. rubric:: See also
+.. rubric:: See Also
 
 - :doc:`pgr_dijkstra`
 - :doc:`pgr_trsp`
@@ -843,7 +843,7 @@ Signature:
 .. contents::
    :local:
 
-.. rubric:: See also
+.. rubric:: See Also
 
 - :doc:`pgr_withPoints`
 - :doc:`pgr_trsp_withPoints`
@@ -904,7 +904,7 @@ Signature:
    :local:
    :depth: 1
 
-.. rubric:: See also
+.. rubric:: See Also
 
 - :doc:`pgr_dijkstraVia`
 - :doc:`pgr_trspVia`
@@ -967,7 +967,7 @@ Signature:
    :local:
    :depth: 1
 
-.. rubric:: See also
+.. rubric:: See Also
 
 - :doc:`pgr_withPointsVia`
 - :doc:`pgr_trspVia_withPoints`

diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -557,9 +557,9 @@ milestone for 3.4.0
 
 * Flow functions
 
-  * pgr_maxCardinalityMatch(text)``
+  * pgr_maxCardinalityMatch(text)
 
-    * Deprecating ``pgr_maxCardinalityMatch(text,boolean)``
+    * Deprecating: pgr_maxCardinalityMatch(text,boolean)
 
 .. rubric:: Deprecated Functions
 
@@ -1368,7 +1368,9 @@ on Github.
 pgRouting 2.5.4 Release Notes
 -------------------------------------------------------------------------------
 
-To see the issues closed by this release see the `Git closed milestone for 2.5.4 <https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%202.5.4%22%20>`_ on Github.
+To see the issues closed by this release see the `Git closed milestone for 2.5.4
+<https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%202.5.4%22%20>`_
+on Github.
 
 * Fixes server crash on several functions.
 

diff --git a/doc/traversal/pgr_breadthFirstSearch.rst b/doc/traversal/pgr_breadthFirstSearch.rst
@@ -55,7 +55,7 @@ Signatures
 
    | pgr_breadthFirstSearch(`Edges SQL`_, **root vid**, [**options**])
    | pgr_breadthFirstSearch(`Edges SQL`_, **root vids**, [**options**])
-   | **options:** [max_depth, directed]``
+   | **options:** ``[max_depth, directed]``
 
    | Returns set of |result-bfs|
 
@@ -69,7 +69,7 @@ Single vertex
    :class: signatures
 
    | pgr_breadthFirstSearch(`Edges SQL`_, **root vid**, [**options**])
-   | **options:** [max_depth, directed]``
+   | **options:** ``[max_depth, directed]``
 
    | Returns set of |result-bfs|
 
@@ -90,7 +90,7 @@ Multiple vertices
    :class: signatures
 
    | pgr_breadthFirstSearch(`Edges SQL`_, **root vids**, [**options**])
-   | **options:** [max_depth, directed]``
+   | **options:** ``[max_depth, directed]``
 
    | Returns set of |result-bfs|
 

diff --git a/doc/trsp/pgr_trsp.rst b/doc/trsp/pgr_trsp.rst
@@ -38,17 +38,17 @@
 
   * Deprecated signatures
 
-    * pgr_trsp(text,integer,integer,boolean,boolean,text)``
-    * pgr_trsp(text,integer,float,integer,float,boolean,boolean,text)``
-    * pgr_trspViaVertices(text,anyarray,boolean,boolean,text)``
-    * pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text)``
+    * pgr_trsp(text,integer,integer,boolean,boolean,text)
+    * pgr_trsp(text,integer,float,integer,float,boolean,boolean,text)
+    * pgr_trspViaVertices(text,anyarray,boolean,boolean,text)
+    * pgr_trspviaedges(text,integer[],double precision[],boolean,boolean,text)
 
 * Version 2.1.0
 
   * New prototypes
 
-    * pgr_trspViaVertices``
-    * pgr_trspViaEdges``
+    * pgr_trspViaVertices
+    * pgr_trspViaEdges
 
 * Version 2.0.0
 

diff --git a/doc/tsp/pgr_TSP.rst b/doc/tsp/pgr_TSP.rst
@@ -16,7 +16,7 @@
 ``pgr_TSP``
 ===============================================================================
 
-* pgr_TSP`` - Aproximation using *metric* algorithm.
+* ``pgr_TSP`` - Aproximation using *metric* algorithm.
 
 .. rubric:: Availability:
 

diff --git a/doc/tsp/pgr_TSPeuclidean.rst b/doc/tsp/pgr_TSPeuclidean.rst
@@ -16,7 +16,7 @@
 ``pgr_TSPeuclidean``
 =============================================================================
 
-* pgr_TSPeuclidean`` - Aproximation using *metric* algorithm.
+* ``pgr_TSPeuclidean`` - Aproximation using *metric* algorithm.
 
 .. rubric:: Availability:
 

diff --git a/doc/utilities/pgr_findCloseEdges.rst b/doc/utilities/pgr_findCloseEdges.rst
@@ -47,7 +47,7 @@ Signatures
 
    | pgr_findCloseEdges(`Edges SQL`_, **point**, **tolerance**, [**options**])
    | pgr_findCloseEdges(`Edges SQL`_, **points**, **tolerance**, [**options**])
-   | **options:** [cap, partial, dryrun]``
+   | **options:** ``[cap, partial, dryrun]``
 
    | Returns set of |result-find|
    | OR EMPTY SET
@@ -62,7 +62,7 @@ One point
    :class: signatures
 
    | pgr_findCloseEdges(`Edges SQL`_, **point**, **tolerance**, [**options**])
-   | **options:** [cap, partial, dryrun]``
+   | **options:** ``[cap, partial, dryrun]``
 
    | Returns set of |result-find|
    | OR EMPTY SET

diff --git a/doc/withPoints/pgr_withPointsDD.rst b/doc/withPoints/pgr_withPointsDD.rst
@@ -51,8 +51,8 @@
 
 * Deprecated signatures
 
-  * pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)``
-  * pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)``
+  * pgr_withpointsdd(text,text,bigint,double precision,boolean,character,boolean)
+  * pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)
 
 .. rubric:: Version 2.2.0