Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(doc) standardize documentation #2719

Merged
merged 2 commits into from
Jan 15, 2025
Merged

(doc) standardize documentation #2719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6e95c8
(doc) standardize documentation
cvvergara Jan 15, 2025
ef5f01f
(doc) fixing typo
cvvergara Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ milestone for 3.6.0
* Signature change: ``driving_side`` parameter changed from named optional to
unnamed compulsory **driving side**.
* Added ``start_vid`` and ``end_vid`` result columns.
* New proposed signatures
* New proposed signatures:
* pgr_withPointsKSP(One to Many)
* pgr_withPointsKSP(Many to One)
* pgr_withPointsKSP(Many to Many)
Expand Down Expand Up @@ -1284,7 +1284,7 @@ on Github.

* pgr_bdAstar(one to one)

**New Proposed functions**
**New proposed functions.**

* pgr_bdAstar(one to many)
* pgr_bdAstar(many to one)
Expand Down Expand Up @@ -1365,12 +1365,12 @@ To see the issues closed by this release see the [Git closed issues for 2.4.0
](https://github.com/pgRouting/pgrouting/issues?q=milestone%3A%22Release+2.4.0%22+is%3Aclosed)
on Github.

**New Signatures**
**New Function.**

* pgr_bdDijkstra


**New Proposed Signatures**
**New proposed signatures:**

* pgr_maxFlow
* pgr_astar(one to many)
Expand All @@ -1382,7 +1382,7 @@ on Github.
* pgr_astarCost(many to many)
* pgr_astarCostMatrix

**Deprecated signatures**
**Deprecated signatures.**

* pgr_bddijkstra - use pgr_bdDijkstra instead

Expand Down Expand Up @@ -1446,7 +1446,7 @@ on Github.
* pgr_eucledianTSP


**New Proposed functions**
**New proposed functions.**

* pgr_dijkstraCostMatrix
* pgr_withPointsCostMatrix
Expand Down
2 changes: 1 addition & 1 deletion doc/allpairs/pgr_floydWarshall.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ each pair of nodes in the graph using Floyd-Warshall algorithm.

* Version 2.0.0

* **Official** function
* Official function.

Description
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/allpairs/pgr_johnson.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pair of nodes in the graph using Floyd-Warshall algorithm.

* Version 2.0.0

* **Official** function
* Official function.

Description
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/alpha_shape/pgr_alphaShape.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

* Version 2.0.0

* **Official** function
* Official function.
* Renamed from version 1.x

.. rubric:: Support
Expand Down
4 changes: 2 additions & 2 deletions doc/astar/pgr_aStar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

* Version 3.0.0

* Function promoted to **official**.
* Function promoted to official.

* Version 2.4.0

Expand All @@ -54,7 +54,7 @@

* Version 2.0.0

* **Official** pgr_aStar(One to One)
* Official function.

Description
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/astar/pgr_aStarCost.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

* Version 3.0.0

* Function promoted to **official**.
* Function promoted to official.

* Version 2.4.0

Expand Down
2 changes: 1 addition & 1 deletion doc/astar/pgr_aStarCostMatrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

* Version 3.0.0

* Function promoted to **official**.
* Function promoted to official.

* Version 2.4.0

Expand Down
6 changes: 3 additions & 3 deletions doc/bdAstar/pgr_bdAstar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.5.0

* New **Proposed** signatures:
* New proposed signatures:

* pgr_bdAstar(One to Many)
* pgr_bdAstar(Many to One)
Expand All @@ -52,7 +52,7 @@

* Version 2.0.0

* **Official** pgr_bdAstar(One to One)
* Official function.

Description
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/bdAstar/pgr_bdAstarCost.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A* algorithm.

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.4.0

Expand Down
2 changes: 1 addition & 1 deletion doc/bdAstar/pgr_bdAstarCostMatrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.5.0

Expand Down
4 changes: 2 additions & 2 deletions doc/bdDijkstra/pgr_bdDijkstra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ algorithm.

* Version 3.0.0

* **Official** function.
* Function promoted to official.

* Version 2.5.0

Expand All @@ -47,7 +47,7 @@ algorithm.

* Version 2.0.0

* **Official** pgr_bdDijkstra(One to One)
* Official function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/bdDijkstra/pgr_bdDijkstraCost.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Dijkstra algorithm.

* Version 3.0.0

* **Official** function
* Function promoted to official.
cvvergara marked this conversation as resolved.
Show resolved Hide resolved

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/components/pgr_articulationPoints.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ graph.
* Version 3.0.0

* Result columns change: ``seq`` is removed
* **Official** function
* Function promoted to official.

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/components/pgr_biconnectedComponents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* n_seq`` is removed
* seq`` changed type to ``BIGINT``

* **Official** function
* Function promoted to official.

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/components/pgr_bridges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* Version 3.0.0

* Result columns change: ``seq`` is removed
* **Official** function
* Function promoted to official.

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/components/pgr_connectedComponents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ a DFS-based approach.
* n_seq`` is removed
* seq`` changed type to ``BIGINT``

* Function propoted to **Official**.
* Function promoted to official.

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/components/pgr_strongComponents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ using Tarjan's algorithm based on DFS.
* ``n_seq`` is removed
* ``seq`` changed type to ``BIGINT``

* **Official** function
* Function promoted to official.

* Version 2.5.0

Expand Down
2 changes: 1 addition & 1 deletion doc/contraction/pgr_contraction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ vertices and edges.
* Result columns change: ``seq`` is removed
* Name change from ``pgr_contractGraph``
* Bug fixes
* **Official** function
* Function promoted to official.

* Version 2.3.0

Expand Down
4 changes: 2 additions & 2 deletions doc/dijkstra/pgr_dijkstra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

* Version 3.0.0

* **Official** function.
* Function promoted to official.

* Version 2.2.0

Expand All @@ -53,7 +53,7 @@

* Version 2.0.0

* **Official** pgr_dijkstra(One to One)
* Official function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/dijkstra/pgr_dijkstraCost.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ algorithm.

* Version 2.2.0

* New **official** function.
* Official function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/dijkstra/pgr_dijkstraCostMatrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.3.0

Expand Down
11 changes: 8 additions & 3 deletions doc/driving_distance/pgr_drivingDistance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,17 @@

.. rubric:: Version 2.1.0

* Signature change pgr_drivingDistance(single vertex)
* New **Official** pgr_drivingDistance(multiple vertices)
* Signature change:

* pgr_drivingDistance(single vertex)

* New official signature:

* pgr_drivingDistance(multiple vertices)

.. rubric:: Version 2.0.0

* Official:: pgr_drivingDistance(single vertex)
* Official function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/ksp/pgr_KSP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

.. rubric:: Version 2.0.0

* **Official** function
* Official function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/lineGraph/pgr_lineGraph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ graph.

* Version 2.5.0

* New **Experimental** function
* New experimental function.


Description
Expand Down
2 changes: 1 addition & 1 deletion doc/lineGraph/pgr_lineGraphFull.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ the vertices from the original graph are converted to line graphs.

* Version 2.6.0

* New **Experimental** function
* New experimental function.


Description
Expand Down
8 changes: 4 additions & 4 deletions doc/max_flow/pgr_boykovKolmogorov.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ the flow from the sources to the targets using Boykov Kolmogorov algorithm.

* Version 3.2.0

* New proposed signature
* New proposed signature:

* pgr_boykovKolmogorov(Combinations)

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.5.0

* Renamed from ``pgr_maxFlowBoykovKolmogorov``
* **Proposed** function
* Function promoted to proposed.

* Version 2.3.0

* New **Experimental** function
* New experimental function.


Description
Expand Down
6 changes: 3 additions & 3 deletions doc/max_flow/pgr_edgeDisjointPaths.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ vertices.

* Version 3.0.0

* **Official** function
* Function promoted to official.

* Version 2.5.0

* **Proposed** function
* Function promoted to proposed.

* Version 2.3.0

* New **Experimental** function
* New experimental function.


Description
Expand Down
Loading
Loading