aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/file_io.lua
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-07-23 13:28:25 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-07-23 13:28:25 -0400
commit98c18a50cc1e4f62414fe2eba491306ee80611f5 (patch)
tree9ee7b117e2990dc3453bc223c3e5b28c78fc3783 /core/file_io.lua
parent0c10d1b7a38e84b11c9e54c29bfda080ce05b89c (diff)
Updated LuaDoc.
Diffstat (limited to 'core/file_io.lua')
-rw-r--r--core/file_io.lua14
1 files changed, 7 insertions, 7 deletions
diff --git a/core/file_io.lua b/core/file_io.lua
index eab122e4..7a582770 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -384,15 +384,15 @@ io.quick_open_filters = {}
-- String or list *filter* determines which files to show in the dialog, with
-- the default filter being `io.quick_open_filters[path]` (if it exists) or
-- `lfs.default_filter`. A filter consists of Lua patterns that match file and
--- directory paths to include or exclude. Exclusive patterns begin with a '!'.
--- If no inclusive patterns are given, any path is initially considered. As a
--- convenience, file extensions can be specified literally instead of as a Lua
--- pattern (e.g. '.lua' vs. '%.lua$'), and '/' also matches the Windows
--- directory separator ('[/\\]' is not needed).
+-- directory paths to include or exclude. Patterns are inclusive by default.
+-- Exclusive patterns begin with a '!'. If no inclusive patterns are given, any
+-- path is initially considered. As a convenience, file extensions can be
+-- specified literally instead of as a Lua pattern (e.g. '.lua' vs. '%.lua$'),
+-- and '/' also matches the Windows directory separator ('[/\\]' is not needed).
-- The number of files in the list is capped at `quick_open_max`.
-- If *filter* is `nil` and *paths* is ultimately a string, the filter from the
--- `io.quick_open_filters` table is used in place of `lfs.default_filter` if the
--- former exists.
+-- `io.quick_open_filters` table is used. If that filter does not exist,
+-- `lfs.default_filter` is used.
-- *opts* is an optional table of additional options for
-- `ui.dialogs.filteredlist()`.
-- @param paths Optional string directory path or table of directory paths to