Skip to content

Commit 51c219e

Browse files
committed
(doc) fixing grammar, spelling and sphinx issues
1 parent ebf8876 commit 51c219e

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

NEWS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ For developers:
3232

3333
Documentation build
3434

35-
* The doxygen documentation is build by default
36-
* The HTML documentation is build by default
37-
* The translated languages (en, es, sv, zh_Hans) HTML documentation is build by
35+
* The doxygen documentation is built by default
36+
* The HTML documentation is built by default
37+
* The translated languages (en, es, sv, zh_Hans) HTML documentation are built by
3838
default
3939
* `WITH-DOC` is not used anymore
4040

41-
User's Documentation is not build when
41+
User Documentation is not built when
4242

4343
* Sphinx is not found
4444
* When all Sphinx formats are OFF
@@ -53,7 +53,7 @@ User's Documentation is not build when
5353

5454
* For example: for HTML output is on `build/doc/_build/html` directory
5555

56-
Developers's Documentation is not build when
56+
Developers' Documentation is not built when
5757

5858
* Doxygen is not found
5959
* To not build Doxygen documentation: `-DBUILD_DOXY=OFF`
@@ -336,7 +336,7 @@ SQL signatures and output standardization
336336
* [#2907](https://github.com/pgRouting/pgrouting/issues/2907): pgr_bellmanFord
337337
* [#2908](https://github.com/pgRouting/pgrouting/issues/2908): pgr_binaryBreadthFirstSearch
338338
* [#2910](https://github.com/pgRouting/pgrouting/issues/2910): pgr_edwardMoore
339-
* [#2913](https://github.com/pgRouting/pgrouting/issues/2913): pgr_DAGshortestPath
339+
* [#2913](https://github.com/pgRouting/pgrouting/issues/2913): pgr_dagShortestPath
340340

341341
**Standardized to ``(start_vid, end_vid, agg_cost)``**
342342

@@ -346,7 +346,7 @@ SQL signatures and output standardization
346346
**Standardized to ``(seq, path_id, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``**
347347

348348
* [#2909](https://github.com/pgRouting/pgrouting/issues/2909): pgr_edgeDisjointPaths
349-
* [#2909](https://github.com/pgRouting/pgrouting/issues/2909): pgr_turnRestrictedPaths
349+
* [#2909](https://github.com/pgRouting/pgrouting/issues/2909): pgr_turnRestrictedPath
350350

351351
**Standardized to ``(edge, color)``**
352352

doc/bdAstar/pgr_bdAstarCostMatrix.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Description
3434

3535
**The main characteristics are:**
3636

37-
* Internally uses the :doc:`pgr_bdAstar` algorithm
37+
* Internally uses the :doc:`pgr_bdAstar` algorithm.
3838
* Returns a cost matrix.
3939
* No ordering is performed
4040
* let `v` and `u` are nodes on the graph:

doc/src/release_notes.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ For developers:
6767
Documentation build
6868
...............................................................................
6969

70-
* The doxygen documentation is build by default
71-
* The HTML documentation is build by default
72-
* The translated languages (en, es, sv, zh_Hans) HTML documentation is build by
70+
* The doxygen documentation is built by default
71+
* The HTML documentation is built by default
72+
* The translated languages (en, es, sv, zh_Hans) HTML documentation are built by
7373
default
7474
* `WITH-DOC` is not used anymore
7575

76-
User's Documentation is not build when
76+
User Documentation is not built when
7777

7878
* Sphinx is not found
7979
* When all Sphinx formats are OFF
@@ -88,7 +88,7 @@ User's Documentation is not build when
8888

8989
* For example: for HTML output is on `build/doc/_build/html` directory
9090

91-
Developers's Documentation is not build when
91+
Developers' Documentation is not built when
9292

9393
* Doxygen is not found
9494
* To not build Doxygen documentation: `-DBUILD_DOXY=OFF`
@@ -392,7 +392,7 @@ SQL signatures and output standardization
392392
* :issue:`2907`: pgr_bellmanFord
393393
* :issue:`2908`: pgr_binaryBreadthFirstSearch
394394
* :issue:`2910`: pgr_edwardMoore
395-
* :issue:`2913`: pgr_DAGshortestPath
395+
* :issue:`2913`: pgr_dagShortestPath
396396

397397
.. rubric:: Standardized to |matrix-result|
398398

@@ -402,7 +402,7 @@ SQL signatures and output standardization
402402
.. rubric:: Standardized to |generic-result|
403403

404404
* :issue:`2909`: pgr_edgeDisjointPaths
405-
* :issue:`2909`: pgr_turnRestrictedPaths
405+
* :issue:`2909`: pgr_turnRestrictedPath
406406

407407
.. rubric:: Standardized to |result_edge_color|
408408

doc/traversal/pgr_binaryBreadthFirstSearch.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ vertices can be found using Breadth First Search in :math:`O(|E|)` in an
5151
unweighted graph, i.e. the distance is the minimal number of edges that you
5252
need to traverse from the source to another vertex. We can interpret such a
5353
graph also as a weighted graph, where every edge has the weight :math:`1`.
54-
If not all edges in graph have the same weight, that we need a more general
55-
algorithm, like Dijkstra's Algorithm which runs in :math:`O(|E|log|V|)` time.
54+
If not all edges in graph have the same weight, then we a more general
55+
algorithm is needed, like Dijkstra's Algorithm which runs in :math:`O(|E|log|V|)` time.
5656

5757
However if the weights are more constrained, we can use a faster algorithm.
5858
This algorithm, termed as 'Binary Breadth First Search' as well as '0-1 BFS',

0 commit comments

Comments
 (0)