Module sheldon

Main module for sheldon.

Copyright © Inaka <hello@inaka.net>

Description

Main module for sheldon. Use this one from your own applications.

Copyright 2016 Inaka <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.

Function Index

check/1Checks the spelling of the iodata() received as a parameter.
check/2Checks the spelling of the iodata() received as a parameter.
start/0Used when starting the application on the shell.

Function Details

check/1

check(Text::iodata()) -> sheldon_result:result()

Equivalent to check(Text, sheldon_config:default()).

Checks the spelling of the iodata() received as a parameter.

check/2

check(Text::iodata(), Config1::sheldon_config:config()) -> sheldon_result:result()

Checks the spelling of the iodata() received as a parameter. It also accepts Config parameter

start/0

start() -> ok

Used when starting the application on the shell.


Generated by EDoc, Oct 24 2016, 10:27:03.