Skip to content

Commit

Permalink
Fix typo, add experimental notice
Browse files Browse the repository at this point in the history
Signed-off-by: Mihai Maruseac <[email protected]>
  • Loading branch information
mihaimaruseac committed Aug 30, 2022
1 parent caa1edf commit 0baa2d5
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pkg/assembler/assembler.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type assembler struct{} //nolint: unused
// change in the future as we discover issues with reading/writing from the
// graph database.
//
// For now, the design of the interface follows these guideliness:
// For now, the design of the interface follows these guidelines:
//
// 1. We want to serialize `GuacNode`s and `GuacEdge`s to graph database
// (e.g. Neo4j) without creating duplicate nodes. To do this, we need
Expand Down Expand Up @@ -64,6 +64,8 @@ type assembler struct{} //nolint: unused
// serialization/deserialization, similar to how json is done.

// GuacNode represents a node in the GUAC graph
// Note: this is experimental and might change. Please refer to source code for
// more details about usage.
type GuacNode interface {
// Type returns the type of node
Type() string
Expand All @@ -86,6 +88,8 @@ type GuacNode interface {
}

// GuacEdge represents an edge in the GUAC graph
// Note: this is experimental and might change. Please refer to source code for
// more details about usage.
type GuacEdge interface {
// Type returns the type of edge
Type() string
Expand Down Expand Up @@ -117,6 +121,8 @@ type GuacEdge interface {
}

// Subgraph represents a subgraph read from the database or written to it.
// Note: this is experimental and might change. Please refer to source code for
// more details about usage.
type Subgraph struct {
V []GuacNode
E []GuacEdge
Expand Down

0 comments on commit 0baa2d5

Please sign in to comment.