aboutsummaryrefslogtreecommitdiff
path: root/core/file_io.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2014-03-28 09:52:09 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2014-03-28 09:52:09 -0400
commit86ad6f9cc48f06dca8fc6235a10715c947eadc92 (patch)
tree8eb93d3af962a1a82813f6ae5d25f5bcd4cdfb4c /core/file_io.lua
parent7785897657cd9c3a5e1483ebacad73939f375a7e (diff)
downloadtextadept-86ad6f9cc48f06dca8fc6235a10715c947eadc92.tar.gz
textadept-86ad6f9cc48f06dca8fc6235a10715c947eadc92.zip
Added more documentation on project building.
Diffstat (limited to 'core/file_io.lua')
-rw-r--r--core/file_io.lua2
1 files changed, 2 insertions, 0 deletions
diff --git a/core/file_io.lua b/core/file_io.lua
index 6e82f66d..3df966c5 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -364,6 +364,8 @@ local vcs = {'.bzr', '.git', '.hg', '.svn', 'CVS'}
---
-- Returns the root directory of the project that contains filesystem path
-- *path*.
+-- In order to be recognized, projects must be under version control. Recognized
+-- VCSes are Bazaar, Git, Mercurial, SVN, and CVS.
-- @param path Optional filesystem path to a project or a file contained within
-- a project. The default value is the buffer's filename or the current
-- working directory.