Module sheldon_config

Description
Data Types
Function Index
Function Details

sheldon's module for config handling.

Description

sheldon's module for config handling.

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

config()

config() = #{lang => sheldon_dictionary:language(), ignore_words => [string()], ignore_patterns => [regex()], ignore_blocks => [ignore_block()]}

ignore_block()

ignore_block() = #{open := regex(), close := regex()}

regex()

regex() = iodata()

Function Index

default/0	returns a default config.
normalize/1	given a config map this method fills the missing keys and convert to lowercase the ignore_words.

Function Details

default/0

default() -> config()

returns a default config

normalize/1

normalize(Config::config()) -> config()

given a config map this method fills the missing keys and convert to lowercase the ignore_words

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