From cd16b202702e230159fbfe6c699e4dda5dc489ef Mon Sep 17 00:00:00 2001 From: Alek Ratzloff Date: Wed, 19 Aug 2020 14:14:47 -0700 Subject: [PATCH] Fix formatting for configuration docs in config.ex and README Signed-off-by: Alek Ratzloff --- README.md | 18 +++++++++--------- lib/config.ex | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 7061ceb..3d1e669 100644 --- a/README.md +++ b/README.md @@ -43,15 +43,15 @@ in the project root. Changing the configuration file can be done setting the env ## Configuration keys -* `server` - the IRC server to connect to. **(required)** -* `nick` - the IRC nickname to use for the bot. **(optional, default "omnibot")** -* `user` - the IRC username to use for the bot. **(optional, default "omnibot")** -* `real` - the IRC realname to use for the bot. **(optional, default "omnibot")** -* `port` - the port to connect to the server on. **(optional, default 6667)** -* `ssl` - whether to use SSL or not. Note that IRC usually uses port 6697 for SSL. **(optional, default false)** -* `channels` - a list of channels that the bot should always join. **(optional, default [])** -* `plugins` - a list of plugins to load and their configuration. **(optional, default [])** -* `plugin_paths` - a list of locations to look for additional plugins. **(optional, default [])** +* `server` - the IRC server to connect to. (required) +* `nick` - the IRC nickname to use for the bot. (optional, default `"omnibot"`) +* `user` - the IRC username to use for the bot. (optional, default `"omnibot"`) +* `real` - the IRC realname to use for the bot. (optional, default `"omnibot"`) +* `port` - the port to connect to the server on. (optional, default `6667`) +* `ssl` - whether to use SSL or not. Note that IRC usually uses port 6697 for SSL. (optional, default `false`) +* `channels` - a list of channels that the bot should always join. (optional, default `[]`) +* `plugins` - a list of plugins to load and their configuration. (optional, default `[]`) +* `plugin_paths` - a list of locations to look for additional plugins. (optional, default `[]`) ### Plugin configuration diff --git a/lib/config.ex b/lib/config.ex index b9165f0..ab134cd 100644 --- a/lib/config.ex +++ b/lib/config.ex @@ -7,16 +7,16 @@ defmodule Omnibot.Config do ## Configuration keys - - server: the IRC server to connect to. **(required)** - - nick: the IRC nickname to use for the bot. **(optional, default "omnibot")** - - user: the IRC username to use for the bot. **(optional, default "omnibot")** - - real: the IRC realname to use for the bot. **(optional, default "omnibot")** - - port: the port to connect to the server on. **(optional, default 6667)** + - server: the IRC server to connect to. (required) + - nick: the IRC nickname to use for the bot. (optional, default `"omnibot"`) + - user: the IRC username to use for the bot. (optional, default `"omnibot"`) + - real: the IRC realname to use for the bot. (optional, default `"omnibot"`) + - port: the port to connect to the server on. (optional, default `6667`) - ssl: whether to use SSL or not. Note that IRC usually uses port 6697 for - SSL. **(optional, default false)** - - channels: a list of channels that the bot should always join. **(optional, default [])** - - plugins: a list of plugins to load and their configuration. **(optional, default [])** - - plugin_paths: a list of locations to look for additional plugins. **(optional, default [])** + SSL. (optional, default `false`) + - channels: a list of channels that the bot should always join. (optional, default `[]`) + - plugins: a list of plugins to load and their configuration. (optional, default `[]`) + - plugin_paths: a list of locations to look for additional plugins. (optional, default `[]`) ## Plugins configuration