summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcpopa <devnull@localhost>2014-05-20 16:47:18 +0300
committercpopa <devnull@localhost>2014-05-20 16:47:18 +0300
commit18c6577b4dacdf5eb1d4ecb5a67c3e4faa489212 (patch)
treea3377d86721aa3f4fdd54538e0e3ef63e4de080a /doc
parent648d5d94d70cebe1cd4ae339ccabefbd126961bc (diff)
downloadpylint-18c6577b4dacdf5eb1d4ecb5a67c3e4faa489212.tar.gz
Document the fact that Pylint does not import modules. Closes issue #249.
Diffstat (limited to 'doc')
-rw-r--r--doc/run.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/run.rst b/doc/run.rst
index 4e752b0..d4a2aa9 100644
--- a/doc/run.rst
+++ b/doc/run.rst
@@ -10,9 +10,11 @@ Pylint is meant to be called from the command line. The usage is ::
pylint [options] module_or_package
You should give Pylint the name of a python package or module. Pylint
-will ``import`` this package or module, so you should pay attention to
-your ``PYTHONPATH``, since it is a common error to analyze an
-installed version of a module instead of the development version.
+``will not import`` this package or module, though uses Python internals
+to locate them and as such is subject to the same rules and configuration.
+You should pay attention to your ``PYTHONPATH``, since it is a common error
+to analyze an installed version of a module instead of the
+development version.
It is also possible to analyze python files, with a few
restrictions. The thing to keep in mind is that Pylint will try to