Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

Commit

Permalink
Add extra description for configurable binds and autocmds
Browse files Browse the repository at this point in the history
  • Loading branch information
Fryuni authored and NTBBloodbath committed Sep 22, 2022
1 parent 47441f5 commit 99f5a78
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,9 @@ module.binds: table<NestConfig>|function -> table<NestConfig> -- Table of Ne
module.autocmds: table<AutoCmd>|function -> table<AutoCmd> -- Table of AutoCmds (see below) or function that returns a table of AutoCmds
```

Use the function form of `module.binds` and `module.autocmds` when values from `module.settings` are referenced on them.
This allows consumers of the module to change the settings first and only them the binds and autocommands will be generated and configured.

```lua
local example = {}

Expand Down

0 comments on commit 99f5a78

Please sign in to comment.