aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/file_io.lua
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-07-16 17:25:51 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-07-16 17:25:51 -0400
commitb35a8dd225b06340022c4971471952c48380b1db (patch)
treee834bfb5b7767296f2a7bfaabde3aa99b88cf98f /core/file_io.lua
parent3eb130fd2ef73745b2b9f796abbce7bdd2b88632 (diff)
Minor LuaDoc updates and spelling corrections.
Diffstat (limited to 'core/file_io.lua')
-rw-r--r--core/file_io.lua15
1 files changed, 8 insertions, 7 deletions
diff --git a/core/file_io.lua b/core/file_io.lua
index 99157cb0..eab122e4 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -85,7 +85,7 @@ io.encodings = {'UTF-8', 'ASCII', 'CP1252', 'UTF-16'}
---
-- Opens *filenames*, a string filename or list of filenames, or the
--- user-selected filenames.
+-- user-selected filename(s).
-- Emits a `FILE_OPENED` event.
-- @param filenames Optional string filename or table of filenames to open. If
-- `nil`, the user is prompted with a fileselect dialog.
@@ -382,12 +382,13 @@ io.quick_open_filters = {}
-- If *paths* is `nil`, uses the current project's root directory, which is
-- obtained from `io.get_project_root()`.
-- String or list *filter* determines which files to show in the dialog, with
--- the default filter being `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).
+-- 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).
-- 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