aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/nvim_python.txt
diff options
context:
space:
mode:
authorTommy Allen <tommy@esdf.io>2016-06-13 14:56:16 -0400
committerJustin M. Keyes <justinkz@gmail.com>2016-06-13 14:56:16 -0400
commit20447ba0983a29537ae9d8df435fdf0f412c4258 (patch)
treeb3bc6e0d033ed9ede49646e4ccbb6b0fa7c14884 /runtime/doc/nvim_python.txt
parent28cc5a06462090a0411201b2c44140c37a433a0f (diff)
downloadrneovim-20447ba0983a29537ae9d8df435fdf0f412c4258.tar.gz
rneovim-20447ba0983a29537ae9d8df435fdf0f412c4258.tar.bz2
rneovim-20447ba0983a29537ae9d8df435fdf0f412c4258.zip
runtime: Add script for Python diagnostic information (#4885)
Diffstat (limited to 'runtime/doc/nvim_python.txt')
-rw-r--r--runtime/doc/nvim_python.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/runtime/doc/nvim_python.txt b/runtime/doc/nvim_python.txt
index a2fc968db4..27955a76b1 100644
--- a/runtime/doc/nvim_python.txt
+++ b/runtime/doc/nvim_python.txt
@@ -8,6 +8,7 @@ Python plugins and scripting in Nvim *nvim-python*
1. Introduction |nvim-python-intro|
2. Quickstart |nvim-python-quickstart|
+3. Troubleshooting |nvim-python-troubleshooting|
==============================================================================
1. Introduction *nvim-python-intro*
@@ -92,4 +93,20 @@ Note: If you disable Python 3 check, you must install neovim module properly.
let g:python3_host_skip_check = 1
<
==============================================================================
+3. Troubleshooting *nvim-python-troubleshooting*
+
+If you are experiencing issues with a plugin that uses the `neovim` Python
+client, you can use the |:CheckHealth| command to quickly rule out your setup
+as a problem.
+
+ *:CheckHealth*
+:CheckHealth[!] Check your setup for common problems that may be keeping a
+ plugin from functioning correctly. Including the output of
+ this command in bug reports can help reduce the amount of
+ time it takes to address your issue. If [!] is present, the
+ output will be placed in a new buffer which can make it
+ easier to save to a file or copy to the clipboard.
+
+
+==============================================================================
vim:tw=78:ts=8:noet:ft=help:norl: