From 86ad6f9cc48f06dca8fc6235a10715c947eadc92 Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Fri, 28 Mar 2014 09:52:09 -0400
Subject: Added more documentation on project building.

---
 core/file_io.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'core/file_io.lua')

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.
-- 
cgit v1.2.3