Skip to content

Commit

Permalink
Small doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
IoannisPanagiotas authored and jjaderberg committed Oct 24, 2023
1 parent 89aecf5 commit 9a5b755
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.gds.doc;

import org.neo4j.gds.functions.AsNodeFunc;
import org.neo4j.gds.paths.dag.longestPath.DagLongestPathStreamProc;

import java.util.List;

class DagLongestPathDocTest extends SingleFileDocTestBase {

@Override
protected List<Class<?>> functions() {
return List.of(AsNodeFunc.class);
}

@Override
protected List<Class<?>> procedures() {
return List.of(
DagLongestPathStreamProc.class
);
}

@Override
protected String adocFile() {
return "pages/algorithms/dag/longest-path.adoc";
}

}
12 changes: 6 additions & 6 deletions doc/modules/ROOT/pages/algorithms/dag/longest-path.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,16 @@ RETURN
nodes(path) as path
ORDER BY index
----
We use the utility function asNode to return the name of node instead of its ID to make results more readable.
We use the utility function `asNode` to return the name of node instead of its ID to make results more readable.

.Results
[opts="header"]
|===
| index | sourceNode | targetNode | totalCost | nodeNames | costs | path
| 0 | "Timber" | "Timber" | 0.0 | ["Timber"] | [0.0] | [Node[0]]
| 1 | "Timber" | "Lumber" | 1.0 | ["Timber", "Lumber"] | [0.0, 1.0] | [Node[0], Node[1]]
| 2 | "Screws" | "Table Maker" | 3.0 | ["Screws", "Table Maker"] | [0.0, 3.0] | [Node[2], Node[3]]
| 3 | "Screws" | "Screws" | 0.0 | ["Screws"] | [0.0] | [Node[2]]
| 4 | "Screws" | "Table" | 4.0 | ["Screws", "Table Maker", "Table"] | [0.0, 3.0, 4.0] | [Node[2], Node[3], Node[4]]
| 0 | "Timber" | "Timber" | 0.0 | [Timber] | [0.0] | [Node[0]]
| 1 | "Timber" | "Lumber" | 1.0 | [Timber, Lumber] | [0.0, 1.0] | [Node[0], Node[1]]
| 2 | "Screws" | "Table Maker" | 3.0 | [Screws, Table Maker] | [0.0, 3.0] | [Node[2], Node[3]]
| 3 | "Screws" | "Screws" | 0.0 | [Screws] | [0.0] | [Node[2]]
| 4 | "Screws" | "Table" | 4.0 | [Screws, Table Maker, Table] | [0.0, 3.0, 4.0] | [Node[2], Node[3], Node[4]]
|===
--

0 comments on commit 9a5b755

Please sign in to comment.