Skip to content

[ksp][doc] fixing wording #2502

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

Merged
cvvergara merged 3 commits into from
Apr 6, 2023
Merged

[ksp][doc] fixing wording #2502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9a1123
[ksp][doc] fixing wording
Mar 28, 2023
3ffc3e8
[ksp][doc] correction
Mar 27, 2023
0c11116
Update locale: commit 3ffc3e8e5
github-actions[bot] Mar 29, 2023
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
6 changes: 3 additions & 3 deletions doc/ksp/pgr_KSP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ Parameters
- Identifier of the departure vertex.
* - **end vid**
- **ANY-INTEGER**
- Identifier of the departure vertex.
- Identifier of the arrival vertex.
* - **K**
- **ANY-INTEGER**
- Number of required paths
- Number of required paths.

Where:

Expand Down Expand Up @@ -116,7 +116,7 @@ KSP Optional parameters
* - ``heap_paths``
- ``BOOLEAN``
- ``false``
- * When ``false`` Returns at most K paths
- * When ``false`` Returns at most K paths.
* When ``true`` all the calculated paths while processing are returned.
* Roughly, when the shortest path has ``N`` edges, the heap will contain
about than ``N * K`` paths for small value of ``K`` and ``K > 5``.
Expand Down
9 changes: 6 additions & 3 deletions locale/en/LC_MESSAGES/pgrouting_doc_strings.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pgRouting v3.4.0-dev\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-03-16 12:56-0600\n"
"POT-Creation-Date: 2023-03-29 04:51+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -6963,7 +6963,7 @@ msgstr ""
msgid "**K**"
msgstr ""

msgid "Number of required paths"
msgid "Number of required paths."
msgstr ""

msgid "KSP Optional parameters"
Expand All @@ -6972,7 +6972,7 @@ msgstr ""
msgid "``heap_paths``"
msgstr ""

msgid "When ``false`` Returns at most K paths"
msgid "When ``false`` Returns at most K paths."
msgstr ""

msgid "When ``true`` all the calculated paths while processing are returned."
Expand Down Expand Up @@ -14525,6 +14525,9 @@ msgstr ""
msgid "Identifier of the destination vertex."
msgstr ""

msgid "Number of required paths"
msgstr ""

msgid ""
"Get :math:`2` paths using left side driving topology, from vertex "
":math:`1` to the closest location on the graph of point `(2.9, 1.8)`."
Expand Down
9 changes: 6 additions & 3 deletions locale/pot/pgrouting_doc_strings.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pgRouting v3.5.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-03-16 12:56-0600\n"
"POT-Creation-Date: 2023-03-29 04:51+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -6118,7 +6118,7 @@ msgstr ""
msgid "**K**"
msgstr ""

msgid "Number of required paths"
msgid "Number of required paths."
msgstr ""

msgid "KSP Optional parameters"
Expand All @@ -6127,7 +6127,7 @@ msgstr ""
msgid "``heap_paths``"
msgstr ""

msgid "When ``false`` Returns at most K paths"
msgid "When ``false`` Returns at most K paths."
msgstr ""

msgid "When ``true`` all the calculated paths while processing are returned."
Expand Down Expand Up @@ -12394,6 +12394,9 @@ msgstr ""
msgid "Identifier of the destination vertex."
msgstr ""

msgid "Number of required paths"
msgstr ""

msgid "Get :math:`2` paths using left side driving topology, from vertex :math:`1` to the closest location on the graph of point `(2.9, 1.8)`."
msgstr ""

Expand Down