vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Tidy up language.

Browse Source 
- Fix some subordinate clause gymnastics
- Signpost the tern configuration advice better
- Signpost the link to the Tern docs better
- Sort out some bullet-list issues
This commit is contained in:
Ben Jackson 2015-12-24 11:46:41 +00:00
parent baba751dab
commit 702081b0ed
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -779,8 +779,8 @@ your file.
project, by following the [instructions][tern-project] in the [Tern][] project, by following the [instructions][tern-project] in the [Tern][]
documentation. documentation.
3. Make sure that Vim's working directory is beneath that directory when working 3. Make sure that Vim's working directory is a descendent of that directory (or
with JavaScript files. that directory itself) when working with JavaScript files.
#### Explanation #### Explanation
@ -788,16 +788,17 @@ JavaScript completion is based on [Tern][]. This completion engine requires a
file named [`.tern-project`][tern-project] to exist in the current working file named [`.tern-project`][tern-project] to exist in the current working
directory or a directory which is an ancestor of the current working directory 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 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 JavaScript file is edited, so Vim's working directory at that time needs to be a
a child of, the directory containing the `.tern-project` file. descendent of the directory containing the `.tern-project` file (or that
directory itself).
Alternatively, as described in the [Tern documentation][tern-docs], a global Alternatively, as described in the [Tern documentation][tern-docs], a global
`.tern-config` file may be used. `.tern-config` file may be used.
Currently, multiple Tern servers, are not supported. To switch to a different Multiple Tern servers, are not supported. To switch to a different
JavaScript project, you can do one of the following: 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 - change Vim's working directory (`:cd /path/to/new/project`) and restart the
`ycmd` server (`:YcmRestartServer`) `ycmd` server (`:YcmRestartServer`)
- change Vim's working directory (`:cd /path/to/new/project`), open a JavaScript - change Vim's working directory (`:cd /path/to/new/project`), open a JavaScript
@ -807,10 +808,10 @@ JavaScript project, you can do one of the following:
#### Tips and tricks #### Tips and tricks
The following advice is based on the author's experience. The canonical This section contains some advice for configuring `.tern-project` and working
reference for correctly configuring Tern is the [documentation][tern-docs]. Any with JavaScript files. The canonical reference for correctly configuring Tern is
issues, improvements, advice, etc. should be sought from the [Tern][] the [Tern documentation][tern-docs]. Any issues, improvements, advice, etc.
project. For example, see the [list of tern should be sought from the [Tern][] project. For example, see the [list of tern
plugins](http://ternjs.net/doc/manual.html#plugins) for the list of plugins plugins](http://ternjs.net/doc/manual.html#plugins) for the list of plugins
which can be enabled in the `plugins` section of the `.tern-project` file. which can be enabled in the `plugins` section of the `.tern-project` file.