From a138e3dfcfa3b2a3b03e257ba5a2ae0902d91b2c Mon Sep 17 00:00:00 2001 From: Eyal Posener Date: Fri, 22 Nov 2019 15:03:53 +0200 Subject: Options: added docs --- predict/options.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/predict/options.go b/predict/options.go index 8d88b54..5bfbac4 100644 --- a/predict/options.go +++ b/predict/options.go @@ -41,11 +41,13 @@ func OptCheck() Option { } } +// Config stores prediction options. type Config struct { complete.Predictor check bool } +// Options return a config from a list of options. func Options(os ...Option) Config { var op Config for _, f := range os { @@ -61,6 +63,8 @@ func (c Config) Predict(prefix string) []string { return nil } +// Check checks that value is one of the predicted values, in case +// that the check field was set. func (c Config) Check(value string) error { if !c.check || c.Predictor == nil { return nil -- cgit v1.2.3