Add syntaxt testing

Author: IoannisPanagiotas

doc-test/src/test/java/org/neo4j/gds/doc/syntax/KSpanningTreeSyntaxTest.java

@@ -0,0 +1,38 @@
+/*
+ * 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.syntax;
+
+import java.util.List;
+
+import static org.neo4j.gds.doc.syntax.SyntaxMode.WRITE;
+
+class KSpanningTreeSyntaxTest extends SyntaxTestBase {
+
+    protected Iterable<SyntaxModeMeta> syntaxModes() {
+        return List.of(
+            SyntaxModeMeta.of(WRITE)
+        );
+    }
+
+    @Override
+    protected String adocFile() {
+        return "pages/alpha-algorithms/k-minimum-weight-spanning-tree.adoc";
+    }
+}

doc/modules/ROOT/pages/alpha-algorithms/k-minimum-weight-spanning-tree.adoc

@@ -21,6 +21,14 @@ The minimum weight k-Spanning Tree is NP-Hard. The algorithm in the Neo4j GDS Li
 [[algorithms-minimum-k-weight-spanning-tree-syntax]]
 == Syntax
 
+include::partial$/algorithms/shared/syntax-intro-named-graph.adoc[]
+
+.K Spanning Tree syntax per mode
+[.tabbed-example, caption = ]
+====
+
+[.include-with-write]
+======
 .The following will run the k-spanning tree algorithms and write back results:
 [source, cypher, role=noplay]
 ----
@@ -31,19 +39,19 @@ CALL gds.alpha.kSpanningTree.write(
 YIELD effectiveNodeCount: Integer,
       preProcessingMillis: Integer,
       computeMillis: Integer,
+      postProcessingMillis: Integer,
       writeMillis: Integer,
       configuration: Map
 ----
+include::partial$/algorithms/common-configuration/common-parameters.adoc[]
 
 .Configuration
 [opts="header",cols="1,1,1,1,4"]
 |===
-| Name                                                                             | Type    | Default | Optional  | Description
-| k                                                                                | Integer | null    | no        | The result is a tree with `k` nodes and `k − 1` relationships.
-| sourceNode                                                                      | Integer | null    | no        | The start node ID.
-| xref:common-usage/running-algos.adoc#common-configuration-relationship-weight-property[relationshipWeightProperty] | String  | null    | yes       | Name of the relationship property to use as weights. If unspecified, the algorithm runs unweighted.
-| writeProperty                                                                    | String  | n/a   | no       | The partition that a node belongs to.
-| objective  | String | 'minimum'  | yes      | If specified, the parameter dictates whether to try and find the minimum or the maximum  k-spanning tree. By default, the algorithm looks for the minimum one. Permitted values are 'minimum' and 'maximum'.
+| Name                                                                             | Type    | Default   | Optional  | Description
+include::partial$/algorithms/common-configuration/common-write-configuration-entries.adoc[]
+include::partial$/algorithms/k-spanning-tree/specific-configuration.adoc[]
+
 |===
 
 .Results
@@ -53,8 +61,13 @@ YIELD effectiveNodeCount: Integer,
 | effectiveNodeCount  | Integer | The number of visited nodes.
 | preProcessingMillis | Integer | Milliseconds for preprocessing the data.
 | computeMillis       | Integer | Milliseconds for running the algorithm.
+| postProcessingMillis | Integer | Milliseconds for postprocessing results of the algorithm.
 | writeMillis         | Integer | Milliseconds for writing result data back.
+| configuration         | Map       | The configuration used for running the algorithm.
+
 |===
+======
+====
 
 [[algorithms-minimum-weight-spanning-tree-sample]]
 == Minimum Weight k-Spanning Tree algorithm examples

doc/modules/ROOT/partials/algorithms/k-spanning-tree/specific-configuration.adoc

@@ -0,0 +1,4 @@
+| k         | Number  | n/a         | no      | The  size of the tree to be returned
+| sourceNode | Integer | null      | n/a        | The starting source node ID.
+| xref:common-usage/running-algos.adoc#common-configuration-relationship-weight-property[relationshipWeightProperty] | String  | null      | yes       | Name of the relationship property to use as weights. If unspecified, the algorithm runs unweighted.
+| objective  | String | 'minimum'  | yes      | If specified, the parameter dictates whether to seek a minimum or the maximum weight k-spanning tree. By default, the procedure looks for a minimum weight k-spanning tree. Permitted values are 'minimum' and 'maximum'.