From 3774a77870e2c01cedb68baf8085be8c2a0165c5 Mon Sep 17 00:00:00 2001 From: sammyette Date: Mon, 10 Jul 2023 23:24:52 -0400 Subject: [PATCH] docs: add paths field to module interface docs --- docs/api/hilbish/hilbish.module.md | 3 +++ module.go | 1 + 2 files changed, 4 insertions(+) diff --git a/docs/api/hilbish/hilbish.module.md b/docs/api/hilbish/hilbish.module.md index 2e4d8e1..77731a8 100644 --- a/docs/api/hilbish/hilbish.module.md +++ b/docs/api/hilbish/hilbish.module.md @@ -24,6 +24,9 @@ https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime Hilbish uses this package as its Lua runtime. You will need to read it to use it for a native plugin. +## Interface fields +- `paths`: A list of paths to search when loading native modules. + ## Functions ### load(path) Loads a module at the designated `path`. diff --git a/module.go b/module.go index 3da87c6..bcb46a2 100644 --- a/module.go +++ b/module.go @@ -10,6 +10,7 @@ import ( // #interface module // native module loading +// #field paths A list of paths to search when loading native modules. /* The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin)