Skip to content

Commit 2432dc1

Browse files
authored
docs: reword fallback option docs & validate sentence (#51)
1 parent 3a095a2 commit 2432dc1

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ milliseconds. The value needs to be higher than the amount of milliseconds it
111111
takes to query your system for the dark mode state. Otherwise, you risk
112112
freezing neovim on shutdown.
113113

114-
`fallback` specifies the theme to use when the auto-detection fails. This can
115-
be particularly useful to specify a default version when remotely connecting
116-
via SSH, or when using neovim on a tty.
114+
`fallback` specifies the appearance (`"dark" | "light"`) to use when the
115+
auto-detection fails. This can be particularly useful to specify a default
116+
version when remotely connecting via SSH, or when using neovim on a tty.
117117

118118
## 🚀 Usage
119119

doc/auto-dark-mode.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ milliseconds. The value needs to be higher than the amount of milliseconds it
9595
takes to query your system for the dark mode state. Otherwise, you risk
9696
freezing neovim on shutdown.
9797

98-
`fallback` specifies the theme to use when the auto-detection fails. This can
99-
be particularly useful to specify a default version when remotely connecting
100-
via SSH, or when using neovim on a tty.
98+
`fallback` specifies the appearance (`"dark" | "light"`) to use when the
99+
auto-detection fails. This can be particularly useful to specify a default
100+
version when remotely connecting via SSH, or when using neovim on a tty.
101101

102102

103103
USAGE *auto-dark-mode-usage*

lua/auto-dark-mode/init.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ local function validate_options(options)
2525
function(opt)
2626
return vim.tbl_contains({ "dark", "light" }, opt)
2727
end,
28-
"`fallback` must be either 'light' or 'dark'",
28+
"`fallback` to be either 'light' or 'dark'",
2929
},
3030
set_dark_mode = { options.set_dark_mode, "function" },
3131
set_light_mode = { options.set_light_mode, "function" },

0 commit comments

Comments
 (0)