aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatěj Cepl <mcepl@cepl.eu>2024-08-28 01:00:22 +0200
committerMatěj Cepl <mcepl@cepl.eu>2024-08-28 01:00:22 +0200
commit23d562d7c8bc5dc0b54cc43ec3e5e10494043041 (patch)
treec46d717b889119cd2887aaabdca6d99c36b438d6
parent4cb2a07856318340405acec7ab2cd52d112f73b9 (diff)
downloadvis-filetype-settings-23d562d7c8bc5dc0b54cc43ec3e5e10494043041.tar.gz
doc: eliminate mentions of the global variable `settings` in docs
-rw-r--r--init.lua6
1 files changed, 3 insertions, 3 deletions
diff --git a/init.lua b/init.lua
index 0c74216..2c98e4f 100644
--- a/init.lua
+++ b/init.lua
@@ -4,9 +4,9 @@
-- This plugin provides a declarative interface for setting vis
-- options depending on filetype.
--
--- It expects a global variable called `settings` to be defined:
+-- It expects a module attribute called `settings` to be defined:
--
--- settings = {
+-- ft.settings = {
-- markdown = {"set expandtab on", "set tabwidth 4"}
-- }
--
@@ -16,7 +16,7 @@
--
-- If you want to do more than setting simple options, you can specify a function instead:
--
--- settings = {
+-- ft.settings = {
-- bash = function(win)
-- -- do things for shell scripts
-- end