Great docs, thanks!

Review status: 0 of 1 files reviewed at latest revision, 2 unresolved discussions.

README.md, line 814 at r1 (raw file):

### C-family Semantic Completion

In order to perform semantic analysis such as code completion, goto and

You might want to capitalize goto as GoTo so it's more obvious you're talking about a command.

README.md, line 910 at r1 (raw file):

As you can see from the trivial example, YCM calls the `FlagsForFile` method,
passing it the file name. The `**kwargs` is for advanced users and can be
ignored for many users. The `FlagsForFile` function returns a dictionary with a

Reword this to "and can usually be ignored."?

Comments from Reviewable

Current coverage is 85.66% (diff: 100%)

Merging #2495 into master will not change coverage

@@             master      #2495   diff @@
==========================================
  Files            18         18          
  Lines          1912       1912          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1638       1638          
  Misses          274        274          
  Partials          0          0          

Powered by Codecov. Last update f34b39d...3eb8a33

OK updated ycmd and the vim docs. This is ready.

Review status: 0 of 3 files reviewed at latest revision, 2 unresolved discussions.

README.md, line 814 at r1 (raw file):

Done.

README.md, line 910 at r1 (raw file):

Done.

Comments from Reviewable

Reviewed 1 of 1 files at r2, 2 of 2 files at r3.
Review status: all files reviewed at latest revision, 2 unresolved discussions.

Comments from Reviewable

That's awesome documentation. Made minor comments but .

Reviewed 1 of 1 files at r1, 1 of 1 files at r2, 2 of 2 files at r3.
Review status: all files reviewed at latest revision, 7 unresolved discussions.

README.md, line 834 at r1 (raw file):

- If using CMake, add `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` when configuring and
  copy or symlink it to the root of your project.

Should we rather suggest to add the line set( CMAKE_EXPORT_COMPILE_COMMANDS ON ) in CMakeLists.txt? Technically, this is doing the same thing but I feel it's more convenient than passing a flag to the cmake command.

README.md, line 837 at r1 (raw file):

- If using Ninja, check out the `compdb` tool (`-t compdb`) in its
  [docs][ninja-compdb]
- If using GNU make, check out [Bear][]

Missing dot at the end of line for these two items.

README.md, line 853 at r1 (raw file):

- If the database contains an entry for the file, the flags for that file are
  used.
- If the file is a header file and a source file with he same root exists in the

The instead of he

README.md, line 816 at r3 (raw file):

In order to perform semantic analysis such as code completion, `GoTo` and
diagnostics, YouCompleteMe uses `libclang`. This is the library version of the
clang compiler, sometimes also referred to as llvm. Like any compiler,

Sorry for being pedantic but I think we should always write proper nouns with their capital letters: LLVM instead of llvm, LibClang instead of libclang, C++ instead of c++, etc.

README.md, line 904 at r3 (raw file):

def FlagsForFile( filename, **kwargs ):
  return {
    'flags': '-x c++ -Wall -Wextra -Werror'.split(),

I am not sure that's a good idea to encourage people to use split(). This will fail with spaces in paths.

Comments from Reviewable

Review status: all files reviewed at latest revision, 6 unresolved discussions, all commit checks successful.

README.md, line 816 at r3 (raw file):

Fine with all of these except LibClang instead of libclang; the lowercase version is the name the libclang project uses.

Comments from Reviewable

Review status: all files reviewed at latest revision, 6 unresolved discussions, all commit checks successful.

README.md, line 816 at r3 (raw file):

Right, the capitalized version is almost never used. Let's keep libclang then.

Comments from Reviewable

All done, and thanks again for the reviews!

Review status: 1 of 3 files reviewed at latest revision, 6 unresolved discussions.

README.md, line 834 at r1 (raw file):

I think I prefer this one because it works for a larger number of use-cases. The case I'm thinking of (which is the one that I personally use it for most) is where changing the CMakeLists.txt is not really part of what I want to do (it would be a separate change to the thing I'm interested in). I think preferring this method lowers the barrier to entry.

In any case, I've added it as an alternative to cover all bases :)

README.md, line 837 at r1 (raw file):

Done.

README.md, line 853 at r1 (raw file):

Done.

README.md, line 904 at r3 (raw file):

OK, i thought this was simpler to read for non-pythonners. But you're right, it's just a potential source of problems. Most programmers can understand lists, right?

Comments from Reviewable

Reviewed 2 of 2 files at r4.
Review status: all files reviewed at latest revision, 3 unresolved discussions.

README.md, line 905 at r4 (raw file):

def FlagsForFile( filename, **kwargs ):
  return {
    'flags': [ '-x', 'c++', '-Wall',  '-Wextra', '-Werror' ],

Two spaces between -Wall and -Wextra.

Comments from Reviewable

Review status: 1 of 3 files reviewed at latest revision, 3 unresolved discussions.

README.md, line 905 at r4 (raw file):

Good spot. Done.

Comments from Reviewable

@homu r+

Reviewed 2 of 2 files at r5.
Review status: all files reviewed at latest revision, 2 unresolved discussions.

Comments from Reviewable

📌 Commit 3eb8a33 has been approved by micbou

⚡ Test exempted - status