From 559c76232e30b0db86cf46652e781cffdf80f56f Mon Sep 17 00:00:00 2001 From: Ben Jackson Date: Thu, 24 Dec 2015 11:49:51 +0000 Subject: [PATCH] update vimdoc --- doc/youcompleteme.txt | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/doc/youcompleteme.txt b/doc/youcompleteme.txt index 7771101a..2ca71488 100644 --- a/doc/youcompleteme.txt +++ b/doc/youcompleteme.txt @@ -986,8 +986,8 @@ Quick start ~ project, by following the instructions [33] in the Tern [10] documentation. -3. Make sure that Vim's working directory is beneath that directory when - working with JavaScript files. +3. Make sure that Vim's working directory is a descendent of that directory + (or that directory itself) when working with JavaScript files. ------------------------------------------------------------------------------- *youcompleteme-explanation* @@ -997,16 +997,16 @@ JavaScript completion is based on Tern [10]. This completion engine requires a file named '.tern-project' [33] to exist in the current working directory or a directory which is an ancestor of the current working directory when the tern server is started. YCM starts the Tern server the first time a JavaScript file -is edited, thus the working directory of Vim must be, or must be a child of, -the directory containing the '.tern-project' file. +is edited, so Vim's working directory at that time needs to be a descendent of +the directory containing the '.tern-project' file (or that directory itself). Alternatively, as described in the Tern documentation [34], a global '.tern- config' file may be used. -Currently, multiple Tern servers, are not supported. To switch to a different -JavaScript project, you can do one of the following: +Multiple Tern servers, are not supported. To switch to a different JavaScript +project, you can do one of the following: -- start a new instance of Vim from the new project's directory, or +- start a new instance of Vim from the new project's directory - change Vim's working directory (':cd /path/to/new/project') and restart the 'ycmd' server (|:YcmRestartServer|) @@ -1020,11 +1020,12 @@ JavaScript project, you can do one of the following: *youcompleteme-tips-tricks* Tips and tricks ~ -The following advice is based on the author's experience. The canonical -reference for correctly configuring Tern is the documentation [34]. Any issues, -improvements, advice, etc. should be sought from the Tern [10] project. For -example, see the list of tern plugins [35] for the list of plugins which can be -enabled in the 'plugins' section of the '.tern-project' file. +This section contains some advice for configuring '.tern-project' and working +with JavaScript files. The canonical reference for correctly configuring Tern +is the Tern documentation [34]. Any issues, improvements, advice, etc. should +be sought from the Tern [10] project. For example, see the list of tern plugins +[35] for the list of plugins which can be enabled in the 'plugins' section of +the '.tern-project' file. ------------------------------------------------------------------------------- *youcompleteme-configuring-tern-for-node-support*