Skip to content

Commit 30a73d8

Browse files
authored
Updating readme with debug/faq issues
1 parent 1e97e4d commit 30a73d8

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

readme.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,11 @@ Nevertheless just a refresher on how to submit bugs:
156156
**(From the FAQ)**
157157

158158
Clear all python cache/compiled files (`*.pyc` files and `__pycache__`
159-
directory and everything under it). In Linux/Unix/MacOS you can run:
159+
directory and everything under it) from your _python-mode_ install directory.
160160

161-
`find . -type f -iname '*.pyc' -o -iname '*.pyo' -delete && find . -type d -name '__pycache__' -delete`
161+
In Linux/Unix/MacOS you can run:
162+
163+
`find <path_to_pymode> -type f -iname '*.pyc' -o -iname '*.pyo' -delete && find . -type d -name '__pycache__' -delete`
162164

163165
Then start python mode with:
164166

@@ -182,14 +184,28 @@ Please, also provide more contextual information such as:
182184
* the python version that vim has loaded in your tests:
183185
* `:PymodePython import sys; print(sys.version_info)` output.
184186
* and if you are using virtualenvs and/or conda, also state that, please.
187+
* It would be good also to provide the output of the two following commands:
188+
* `git status` (under your _python-mode_ directory)
189+
* `tree <python-mode-directory>` or something similar (such as `ls -lR`)
185190

186191
# Frequent problems
187192

188193
Read this section before opening an issue on the tracker.
189194

195+
## Python 2/3 vim support
196+
197+
Vim [has issues](https://github.com/vim/vim/issues/3585) to work with both
198+
python2 and python3 at the same time, so if your VIM is compiled with support
199+
to both version you may find problems. The best way to handle it is to build
200+
your vim again with only python3 support.
201+
[Here](https://github.com/ycm-core/YouCompleteMe/wiki/Building-Vim-from-source)
202+
is a good reference on how to build vim from source.
203+
190204
## Python 3 syntax
191205

192-
By default python-mode uses python 3 syntax checking.
206+
`python-mode` supports only python3, so, if you are using python2 we cannot
207+
help you that much. Look for our branch with python2-support (old version,
208+
not maintained anymore) (`last-py2-support`).
193209

194210
## Symlinks on Windows
195211

@@ -208,8 +224,8 @@ Then we probably changed some repo reference or some of our dependencies had a
208224
`git push --force` in its git history. So the best way for you to handle it is
209225
to run, inside the `python-mode` directory:
210226

211-
`git submodule update --recursive --init --force`
212-
`git submodule sync --recursive`
227+
* `git submodule update --recursive --init --force`
228+
* `git submodule sync --recursive`
213229

214230
# Documentation
215231

0 commit comments

Comments
 (0)