8000 Doc - Remove _getConnectingEdges() as it's not implemented (#7624) · arangodb/arangodb@65d451c · GitHub
[go: up one dir, main page]

Skip to content

Commit 65d451c

Browse files
Simran-Bsleto-it
authored andcommitted
Doc - Remove _getConnectingEdges() as it's not implemented (#7624)
1 parent ff24744 commit 65d451c

File tree

2 files changed

+0
-48
lines changed

2 files changed

+0
-48
lines changed

Documentation/Books/Manual/Graphs/GeneralGraphs/Management.md

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -871,47 +871,3 @@ If this edge is used as a vertex by another edge, the other edge will be removed
871871
~ examples.dropGraph("social");
872872
@END_EXAMPLE_ARANGOSH_OUTPUT
873873
@endDocuBlock generalGraphEdgeCollectionRemove
874-
875-
876-
877-
### Connect edges
878-
879-
880-
881-
Get all connecting edges between 2 groups of vertices defined by the examples
882-
883-
`graph._getConnectingEdges(vertexExample, vertexExample2, options)`
884-
885-
The function accepts an id, an example, a list of examples or even an empty
886-
example as parameter for vertexExample.
887-
888-
889-
**Parameters**
890-
891-
* vertexExample1 (optional) See [Definition of examples](Functions.md#definition-of-examples)
892-
* vertexExample2 (optional) See [Definition of examples](Functions.md#definition-of-examples)
893-
* options (optional) An object defining further options. Can have the following values:
894-
* *edgeExamples*: Filter the edges, see [Definition of examples](Functions.md#definition-of-examples)
895-
* *edgeCollectionRestriction* : One or a list of edge-collection names that should be
896-
considered to be on the path.
897-
* *vertex1CollectionRestriction* : One or a list of vertex-collection names that should be
898-
considered on the intermediate vertex steps.
899-
* *vertex2CollectionRestriction* : One or a list of vertex-collection names that should be
900-
considered on the intermediate vertex steps.
901-
902-
903-
**Examples**
904-
905-
906-
A route planner example, all connecting edges between capitals.
907-
908-
@startDocuBlockInline generalGraphModuleConnectingEdges1
909-
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphModuleConnectingEdges1}
910-
var examples = require("@arangodb/graph-examples/example-graph.js");
911-
var graph = examples.loadGraph("routeplanner");
912-
graph._getConnectingEdges({isCapital : true}, {isCapital : true});
913-
~ examples.dropGraph("routeplanner");
914-
@END_EXAMPLE_ARANGOSH_OUTPUT
915-
@endDocuBlock generalGraphModuleConnectingEdges1
916-
917-

Documentation/Examples/generalGraphModuleConnectingEdges1.generated

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)
0