Skip to content

Commit c5b82b4

Browse files
committed
Just adding some more info for debuggin and troubleshooting section
1 parent 9b3f00d commit c5b82b4

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

doc/pymode.txt

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ CONTENTS *pymode-contents
4040

4141
XXX IMPORTANT: As of 2017-11-18 python-mode is going through a major redesign.
4242
Thus some of its functionality may not work as expected. Please be patient and
43-
do report bugs or inconsistencies in its documentation.
43+
do report bugs or inconsistencies in its documentation. But remember to look
44+
for already openned bug reports for the same issue before creating a new one.
4445

4546
Python-mode is a vim plugin that allows you to use the pylint, rope, and pydoc
4647
libraries in vim to provide features like python code bug checking,
@@ -693,7 +694,14 @@ Highlight docstrings as pythonDocstring (otherwise as pythonString)
693694
1. Python-mode doesn't work
694695
---------------------------
695696

696-
Start python mode with:
697+
Remember to get the latest and updated version of the project source code and
698+
also update the project submodules.
699+
700+
Clear all python cache/compiled files (`*.pyc` files and `__pycache__`
701+
directory and everything under it). In Linux/Unix/MacOS you can run:
702+
`find . -type f -name '*.pyc' -delete && find . -type d -name '__pycache__' -delete`
703+
704+
Then start python mode with:
697705
`vim -i NONE -u <path_to_pymode>/debugvimrc.vim`
698706
Reproduce the error and submit your python mode debug file. You can check its
699707
location with `:messages` for something like:

readme.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,12 @@ If your question is not described there then you already know what to do
140140

141141
Nevertheless just a refresher on how to submit bugs:
142142

143-
**(From the FAQ)** Start python mode with:
143+
**(From the FAQ)**
144+
Clear all python cache/compiled files (`*.pyc` files and `__pycache__`
145+
directory and everything under it). In Linux/Unix/MacOS you can run:
146+
`find . -type f -name '*.pyc' -delete && find . -type d -name '__pycache__' -delete`
147+
148+
Then start python mode with:
144149
`vim -i NONE -u <path_to_pymode>/debugvimrc.vim`
145150
Reproduce the error and submit your python mode debug file. You can check its
146151
location with `:messages` for something like:

0 commit comments

Comments
 (0)