From 22fa8fdfa492f46168854199e869d524eb20ec0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Garcia?= Date: Fri, 3 Sep 2021 11:08:52 -0300 Subject: [PATCH] Improve the description of the Provider interface --- README.md | 2 +- contracts.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2fe2de1..f791f58 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ The current interface is as follows and we plan on keeping it with as little functions as possible, so don't expect many additions: ```go -// Provider describes the public behavior of this ORM +// Provider describes the ksql public behavior type Provider interface { Insert(ctx context.Context, table Table, record interface{}) error Update(ctx context.Context, table Table, record interface{}) error diff --git a/contracts.go b/contracts.go index 0599770..3325bce 100644 --- a/contracts.go +++ b/contracts.go @@ -14,7 +14,7 @@ var ErrRecordNotFound error = errors.Wrap(sql.ErrNoRows, "ksql: the query return // ErrAbortIteration ... var ErrAbortIteration error = fmt.Errorf("ksql: abort iteration, should only be used inside QueryChunks function") -// Provider describes the public behavior of this ORM +// Provider describes the ksql public behavior type Provider interface { Insert(ctx context.Context, table Table, record interface{}) error Update(ctx context.Context, table Table, record interface{}) error