Module sheldon_result

Result model.

Copyright © Erlang Solutions Ltd. <hello@inaka.net>

Description

Result model.

Copyright Erlang Solutions Ltd. 2017 <hello@inaka.net>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Data Types

line_number()

line_number() = pos_integer()

misspelled_word()

misspelled_word() = #{line_number := line_number(), word := string(), candidates := [string()]}

result()

result() = ok | #{misspelled_words := [misspelled_word()], bazinga := string()}

Function Index

result/2Returns a result() type given some misspelled words.

Function Details

result/2

result(MisspelledWords::[misspelled_word()], Config::sheldon_config:config()) -> result()

Returns a result() type given some misspelled words.


Generated by EDoc