Skip to content

Commit f3d9e28

Browse files
committed
doc: remove "Go API" section
The note should be written in GoDoc.
1 parent 23bbeeb commit f3d9e28

File tree

1 file changed

+1
-61
lines changed

1 file changed

+1
-61
lines changed

_docs/json-dsl.md

Lines changed: 1 addition & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ or `volt history undo` command is executed. The transaction log file does not
126126
have ID but the saved directory `{id}` does:
127127

128128
```
129-
$VOLTPATH/trx/{id}/{logfile}
129+
$VOLTPATH/trx/{id}/log.json
130130
```
131131

132132
`{id}` is called transaction ID, a simple serial number assigned `max + 1` like
@@ -727,63 +727,3 @@ Here is more complex example to install two plugins "tyru/open-browser.vim",
727727
["$array", "default"]],
728728
["plugconf/install", "github.com/tyru/open-browser-github.vim"]]]]]]
729729
```
730-
731-
### Go API
732-
733-
* dsl package
734-
* `Execute(Context, Expr) (val Value, rollback func(), err error)`
735-
* Executes in new transacton.
736-
* In the given context, if the following keys are missing, returns an error.
737-
* lock.json information `*lockjson.LockJSON`
738-
* config.toml information `*config.Config`
739-
* And this function sets the below key before execution.
740-
* Transaction ID: assigns `max + 1`
741-
742-
* dsl/types package
743-
* Value interface
744-
* `Eval(Context) (val Value, rollback func(), err error)`
745-
* Evaluate this value. the value of JSON literal just returns itself as-is.
746-
* `Invert() (Value, error)`
747-
* Returns inverse expression.
748-
* Null struct
749-
* implements Value
750-
* NullType Type = 1
751-
* var NullValue Null
752-
* Bool struct
753-
* implements Value
754-
* BoolType Type = 2
755-
* var TrueValue Bool
756-
* var FalseValue Bool
757-
* Number struct
758-
* implements Value
759-
* NumberType Type = 3
760-
* String struct
761-
* implements Value
762-
* StringType Type = 4
763-
* Array struct
764-
* implements Value
765-
* ArrayType Type = 5
766-
* Object struct
767-
* implements Value
768-
* ObjectType Type = 6
769-
* Expr struct
770-
* implements Value
771-
* Op Op
772-
* Args []Value
773-
* Type Type
774-
775-
* dsl/op package
776-
* `signature(types Type...) *sigChecker`
777-
* `sigChecker.check(args []Value) error`
778-
* Returns nil if the types of args match.
779-
* Returns non-nil error otherwise.
780-
* Op interface
781-
* `Bind(args []Value...) (*Expr, error)`
782-
* Binds arguments to this operator, and returns an expression.
783-
* Checks semantics (type) of each argument.
784-
* Sets the result type of Expr.
785-
* `InvertExpr(args []Value) (*Expr, error)`
786-
* Returns inverse expression. This normally inverts operator and arguments
787-
and call Bind() (not all operators do it).
788-
* `Execute(ctx Context, args []Value) (val Value, rollback func(), err error)`
789-
* Executes expression (operator + args).

0 commit comments

Comments
 (0)