From 0c55527a38f3ae2111a0071ec85385a15b23a3c8 Mon Sep 17 00:00:00 2001
From: Kenny Kaye <kenny@kaye.us>
Date: Sat, 5 Dec 2015 11:06:29 -0800
Subject: [PATCH] Included usage example for error/warning getters

---
 README.md             | 6 ++++++
 doc/youcompleteme.txt | 6 ++++++
 2 files changed, 12 insertions(+)

diff --git a/README.md b/README.md
index ca4d0b78..139f6f8d 100644
--- a/README.md
+++ b/README.md
@@ -1135,6 +1135,11 @@ For example:
   call youcompleteme#GetErrorCount()
 ```
 
+Both this function and `youcompleteme#GetWarningCount` can be useful when
+integrating YCM with other Vim plugins. For example, a [lightline][] user could
+add a diagnostics section to their statusline which would display the number of
+errors and warnings.
+
 ### The `youcompleteme#GetWarningCount` function
 
 Get the number of YCM Diagnostic warnings. If no warnings are present, this
@@ -2373,6 +2378,7 @@ This software is licensed under the [GPL v3 license][gpl].
 [gpl]: http://www.gnu.org/copyleft/gpl.html
 [vim]: http://www.vim.org/
 [syntastic]: https://github.com/scrooloose/syntastic
+[lightline]: https://github.com/itchyny/lightline.vim
 [flags_example]: https://github.com/Valloric/ycmd/blob/master/cpp/ycm/.ycm_extra_conf.py
 [compdb]: http://clang.llvm.org/docs/JSONCompilationDatabase.html
 [subsequence]: https://en.wikipedia.org/wiki/Subsequence
diff --git a/doc/youcompleteme.txt b/doc/youcompleteme.txt
index 1721140a..6c0ce1f1 100644
--- a/doc/youcompleteme.txt
+++ b/doc/youcompleteme.txt
@@ -1363,6 +1363,11 @@ For example:
 >
   call youcompleteme#GetErrorCount()
 <
+Both this function and |youcompleteme#GetWarningCount| can be useful when
+integrating YCM with other Vim plugins. For example, a lightline [48] user
+could add a diagnostics section to their statusline which would display the
+number of errors and warnings.
+
 -------------------------------------------------------------------------------
 The *youcompleteme#GetWarningCount* function
 
@@ -2627,5 +2632,6 @@ References ~
 [45] http://www.gnu.org/copyleft/gpl.html
 [46] https://bitdeli.com/free
 [47] https://d2weczhvl823v0.cloudfront.net/Valloric/youcompleteme/trend.png
+[48] https://github.com/itchyny/lightline.vim
 
 vim: ft=help