From 153a89b188985f63aac17932ec4f4c03e035d82b Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Mon, 20 Jun 2022 20:47:56 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/fs.txt | 9 +++++++++ emmyLuaDocs/fs.lua | 12 ++++++++++++ 2 files changed, 21 insertions(+) diff --git a/docs/fs.txt b/docs/fs.txt index e9f1548..c3d173e 100644 --- a/docs/fs.txt +++ b/docs/fs.txt @@ -1,7 +1,16 @@ abs(path) > Gives an absolute version of `path`. +basename(path) > Gives the basename of `path`. For the rules, +see Go's filepath.Base + cd(dir) > Changes directory to `dir` +dir(path) > Returns the directory part of `path`. For the rules, see Go's +filepath.Dir + +glob(pattern) > Glob all files and directories that match the pattern. +For the rules, see Go's filepath.Glob + mkdir(name, recursive) > Makes a directory called `name`. If `recursive` is true, it will create its parent directories. readdir(dir) > Returns a table of files in `dir` diff --git a/emmyLuaDocs/fs.lua b/emmyLuaDocs/fs.lua index cd82d5c..5fbfb2b 100644 --- a/emmyLuaDocs/fs.lua +++ b/emmyLuaDocs/fs.lua @@ -6,10 +6,22 @@ local fs = {} --- @param path string function fs.abs(path) end +--- Gives the basename of `path`. For the rules, +--- see Go's filepath.Base +function fs.basename() end + --- Changes directory to `dir` --- @param dir string function fs.cd(dir) end +--- Returns the directory part of `path`. For the rules, see Go's +--- filepath.Dir +function fs.dir() end + +--- Glob all files and directories that match the pattern. +--- For the rules, see Go's filepath.Glob +function fs.glob() end + --- Makes a directory called `name`. If `recursive` is true, it will create its parent directories. --- @param name string --- @param recursive boolean