From 56d224d7455ef84aed99ab96d39bfcac2473a941 Mon Sep 17 00:00:00 2001 From: ioannispan Date: Mon, 23 Oct 2023 09:04:01 +0200 Subject: [PATCH] Small doc fixes --- .../neo4j/gds/doc/DagLongestPathDocTest.java | 46 +++++++++++++++++++ .../pages/algorithms/dag/longest-path.adoc | 12 ++--- 2 files changed, 52 insertions(+), 6 deletions(-) create mode 100644 doc-test/src/test/java/org/neo4j/gds/doc/DagLongestPathDocTest.java diff --git a/doc-test/src/test/java/org/neo4j/gds/doc/DagLongestPathDocTest.java b/doc-test/src/test/java/org/neo4j/gds/doc/DagLongestPathDocTest.java new file mode 100644 index 0000000000..7fa3b03adb --- /dev/null +++ b/doc-test/src/test/java/org/neo4j/gds/doc/DagLongestPathDocTest.java @@ -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 . + */ +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> functions() { + return List.of(AsNodeFunc.class); + } + + @Override + protected List> procedures() { + return List.of( + DagLongestPathStreamProc.class + ); + } + + @Override + protected String adocFile() { + return "pages/algorithms/dag/longest-path.adoc"; + } + +} diff --git a/doc/modules/ROOT/pages/algorithms/dag/longest-path.adoc b/doc/modules/ROOT/pages/algorithms/dag/longest-path.adoc index 172dd01282..23b20601ab 100644 --- a/doc/modules/ROOT/pages/algorithms/dag/longest-path.adoc +++ b/doc/modules/ROOT/pages/algorithms/dag/longest-path.adoc @@ -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]] |=== --