mirror of
https://fuchsia.googlesource.com/third_party/github.com/pylint-dev/pylint
synced 2024-09-21 07:58:04 +00:00
ebae36e354
* Add documentation for ``pyreverse`` and ``symilar`` * Rephrase "additional tools" to "additional commands" to be consistent with Readme * Replace some example diagrams with PlantUML ones and fix errors preventing the doc to build * Incorporate review feedback * Only hint to the ``-h`` option instead of including all options manually in the docs
28 lines
596 B
ReStructuredText
28 lines
596 B
ReStructuredText
|
|
Pylint User Manual
|
|
==================
|
|
|
|
Pylint is a tool that checks for errors in Python code, tries to enforce a
|
|
coding standard and looks for code smells. It can also look for certain type
|
|
errors, it can recommend suggestions about how particular blocks can be
|
|
refactored and can offer you details about the code's complexity.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:titlesonly:
|
|
|
|
intro
|
|
tutorial
|
|
|
|
user_guide/index.rst
|
|
how_tos/index.rst
|
|
technical_reference/index.rst
|
|
development_guide/index.rst
|
|
additional_commands/index.rst
|
|
|
|
faq
|
|
backlinks
|
|
support
|
|
whatsnew/index.rst
|