Documentation
¶
Overview ¶
Package spell provides functions for spell check and correction
Index ¶
- Variables
- func Asset(name string) ([]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func CheckWord(w string) (suggests []string, known bool, err error)
- func Complete(s string) (result []string, err error)
- func DoIgnore(word string) bool
- func IgnoreWord(word string)
- func Initialized() bool
- func LearnWord(word string)
- func Load(path string) error
- func LoadDefault() error
- func MustAsset(name string) []byte
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- func Save(filename string) error
- func Train(file os.File, new bool) (err error)
- type Edit
- type EditFunc
Constants ¶
This section is empty.
Variables ¶
var Ignore []string
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/
foo.txt
img/
a.png
b.png
then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetNames ¶
func AssetNames() []string
AssetNames returns the names of the assets. nolint: deadcode
func CheckWord ¶
CheckWord checks a single word and returns suggestions if word is unknown Programs should call gi.CheckWord - all program calls should be done through that single API
func Initialized ¶
func Initialized() bool
Initialized returns true if the model has been loaded or created anew
func LoadDefault ¶
func LoadDefault() error
LoadDefault loads the default spelling file. Todo: need different languages obviously!
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables. nolint: deadcode
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively
Types ¶
type Edit ¶
type Edit struct {
NewText string `desc:"spelling correction text after special edits if needed"`
}
func CorrectText ¶
CorrectText replaces the old unknown word with the new word chosen from the list of corrections delta is the change in cursor position (cp).
Source Files