summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorClaudiu Popa <pcmanticore@gmail.com>2014-11-07 01:03:56 +0200
committerClaudiu Popa <pcmanticore@gmail.com>2014-11-07 01:03:56 +0200
commiteff9b582c63677ca5c76bcffe2a50ab8c20f1cbc (patch)
tree117c0d96169f5e8d29ecf5bc45a527bd3789bd46 /doc
parent413d634d27d3de0a9509dd7d9ff44d5b62f791b4 (diff)
parentad731e78eecc677e85bbe80d89a7cdf87fbd7922 (diff)
downloadpylint-eff9b582c63677ca5c76bcffe2a50ab8c20f1cbc.tar.gz
Merged in godfryd/pylint/docs-improvements-2 (pull request #197)
Documentation improvements
Diffstat (limited to 'doc')
-rw-r--r--doc/ide-integration.rst36
-rw-r--r--doc/options.rst10
2 files changed, 22 insertions, 24 deletions
diff --git a/doc/ide-integration.rst b/doc/ide-integration.rst
index de5116c..7507fb1 100644
--- a/doc/ide-integration.rst
+++ b/doc/ide-integration.rst
@@ -3,35 +3,33 @@
IDE integration
=================
-To use Pylint with Emacs, see http://www.emacswiki.org/emacs/PythonProgrammingInEmacs#toc8
+To use Pylint with:
-To use Pylint with Vim, see
-http://www.vim.org/scripts/script.php?script_id=891
+ - Emacs_, see http://www.emacswiki.org/emacs/PythonProgrammingInEmacs#toc8,
+ - Vim_, see http://www.vim.org/scripts/script.php?script_id=891,
+ - Eclipse_ and PyDev_, see http://pydev.org/manual_adv_pylint.html,
+ - Komodo_, see http://mateusz.loskot.net/posts/2006/01/15/running-pylint-from-komodo/,
+ - gedit_, see https://launchpad.net/gedit-pylint-2 or https://wiki.gnome.org/Apps/Gedit/PylintPlugin,
+ - WingIDE_, see http://www.wingware.com/doc/edit/pylint,
+ - PyCharm_, see http://blog.saturnlaboratories.co.za/archive/2012/09/10/running-pylint-pycharm.
-To use Pylint with Eclipse, see http://pydev.org
+Pylint is integrated in:
-To use Pylint with Komodo_, see
-http://mateusz.loskot.net/2006/01/15/running-pylint-from-komodo/
-
-To use Pylint with gedit_, see
-http://live.gnome.org/Gedit/PylintPlugin
-
-To use Pylint with WingIDE_, see
-http://www.wingware.com/doc/edit/pylint
-
-Pylint is integrated in Eric_ IDE, see the `Project > Check` menu.
-
-Pylint is integrated in Spyder_, see http://packages.python.org/spyder/pylint.html
-
-Pylint is integrated in pyscripter_, see the `Tool -> Tools` menu.
+ - Eric_ IDE, see the `Project > Check` menu,
+ - Spyder_, see http://packages.python.org/spyder/pylint.html,
+ - pyscripter_, see the `Tool -> Tools` menu.
+.. _Emacs: http://www.gnu.org/software/emacs/
+.. _Vim: http://www.vim.org/
+.. _Eclipse: https://www.eclipse.org/
.. _Eric: http://eric-ide.python-projects.org/
.. _pyscripter: http://code.google.com/p/pyscripter/
.. _pydev: http://pydev.org
.. _Komodo: http://www.activestate.com/Products/Komodo/
-.. _gedit: http://www.gnome.org/projects/gedit/
+.. _gedit: https://wiki.gnome.org/Apps/Gedit
.. _WingIDE: http://www.wingware.com/
.. _spyder: http://code.google.com/p/spyderlib/
+.. _PyCharm: http://www.jetbrains.com/pycharm/
Using Pylint thru flymake in Emacs
==================================
diff --git a/doc/options.rst b/doc/options.rst
index 702d93c..d005dd2 100644
--- a/doc/options.rst
+++ b/doc/options.rst
@@ -1,13 +1,13 @@
.. -*- coding: utf-8 -*-
===============
- Configuration
+ Configuration
===============
Naming Styles
-------------
-PyLint recognizes a number of different name types internally. With a few
+Pylint recognizes a number of different name types internally. With a few
exceptions, the type of the name is governed by the location the assignment to a
name is found in, and not the type of object assigned.
@@ -88,10 +88,10 @@ Large code bases that have been worked on for multiple years often exhibit an
evolution in style as well. In some cases, modules can be in the same package,
but still have different naming style based on the stratum they belong to.
However, intra-module consistency should still be required, to make changes
-inside a single file easier. For this case, PyLint supports regular expression
-with several named capturing group.
+inside a single file easier. For this case, Pylint supports regular expression
+with several named capturing group.
-Rather than emitting name warnings immediately, PyLint will determine the
+Rather than emitting name warnings immediately, Pylint will determine the
prevalent naming style inside each module and enforce it on all names.
Consider the following (simplified) example::