Skip to content

Commit 604d71b

Browse files
Pierre-SassoulasPierre-Sassoulas
committed
[Doc] Create a contact section and cleanup the introduction
1 parent e72fe66 commit 604d71b

File tree

8 files changed

+95
-155
lines changed

8 files changed

+95
-155
lines changed

‎doc/backlinks.rst

-14
This file was deleted.

‎doc/contact/contact.rst

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Bug reports, feedback
2+
---------------------
3+
.. _bug reports, feedback:
4+
5+
You think you have found a bug in Pylint? Well, this may be the case
6+
since Pylint and python are under heavy development!
7+
8+
Please take the time to check if it is already in the issue tracker at
9+
https://github.com/PyCQA/pylint
10+
11+
Note that if you don't find something you have expected in Pylint's issue
12+
tracker, it may be because it is an issue with one of its dependencies, namely
13+
astroid:
14+
15+
* https://github.com/PyCQA/astroid
16+
17+
Discord server
18+
--------------
19+
20+
You can discuss your problem using the discord server:
21+
22+
https://discord.com/invite/Egy6P8AMB5
23+
24+
Mailing lists
25+
-------------
26+
27+
.. _Mailing lists:
28+
29+
The code-quality mailing list is shared with other tools that aim
30+
at improving the quality of python code.
31+
32+
You can subscribe to this mailing list at
33+
https://mail.python.org/mailman3/lists/code-quality.python.org/
34+
35+
Archives are available at
36+
https://mail.python.org/pipermail/code-quality/
37+
38+
Archives before April 2013 are available at
39+
https://lists.logilab.org/pipermail/python-projects/
40+
41+
Support
42+
-------
43+
44+
.. image:: ../media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White.png
45+
:height: 150
46+
:alt: Tidelift
47+
:align: left
48+
:class: tideliftlogo
49+
50+
Professional support for pylint is available as part of the `Tidelift
51+
Subscription`_. Tidelift gives software development teams a single source for
52+
purchasing and maintaining their software, with professional grade assurances
53+
from the experts who know it best, while seamlessly integrating with existing
54+
tools.
55+
56+
.. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-pylint?utm_source=pypi-pylint&utm_medium=referral&utm_campaign=readme

‎doc/contact/index.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Contact
2+
=======
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
:titlesonly:
7+
8+
contact

‎doc/development_guide/contribute.rst

-45
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,6 @@
44
Contributing
55
==============
66

7-
.. _bug reports, feedback:
8-
9-
Bug reports, feedback
10-
---------------------
11-
12-
You think you have found a bug in Pylint? Well, this may be the case
13-
since Pylint is under heavy development!
14-
15-
Please take the time to check if it is already in the issue tracker at
16-
https://github.com/PyCQA/pylint
17-
18-
If you cannot find it in the tracker, create a new issue there or discuss your
19-
problem on the [email protected] mailing list or using the discord
20-
server https://discord.com/invite/Egy6P8AMB5.
21-
22-
The code-quality mailing list is also a nice place to provide feedback about
23-
Pylint, since it is shared with other tools that aim at improving the quality of
24-
python code.
25-
26-
Note that if you don't find something you have expected in Pylint's issue
27-
tracker, it may be because it is an issue with one of its dependencies, namely
28-
astroid:
29-
30-
* https://github.com/PyCQA/astroid
31-
32-
.. _Mailing lists:
33-
34-
Discord server
35-
--------------
36-
37-
https://discord.com/invite/Egy6P8AMB5
38-
39-
Mailing lists
40-
-------------
41-
42-
You can subscribe to this mailing list at
43-
https://mail.python.org/mailman3/lists/code-quality.python.org/
44-
45-
Archives are available at
46-
https://mail.python.org/pipermail/code-quality/
47-
48-
Archives before April 2013 are available at
49-
https://lists.logilab.org/pipermail/python-projects/
50-
51-
527
.. _repository:
538

549
Repository

‎doc/faq.rst

-10
Original file line numberDiff line numberDiff line change
@@ -303,13 +303,3 @@ Pylint, you can set ``evaluation`` to the above expression to get the new
303303
behavior. Likewise, since negative values are still technically supported,
304304
``evaluation`` can be set to a version of the above expression that does not
305305
enforce a floor of zero.
306-
307-
6.2 I think I found a bug in Pylint. What should I do?
308-
-------------------------------------------------------
309-
310-
Read :ref:`Bug reports, feedback`
311-
312-
6.3 I have a question about Pylint that isn't answered here.
313-
------------------------------------------------------------
314-
315-
Read :ref:`Mailing lists`

‎doc/index.rst

+31-11
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
1+
Pylint documentation
2+
====================
13

2-
Pylint User Manual
3-
==================
4+
Pylint is a `static code analyser`_ for python 2 or 3. Only python interpreter above 3.7.2 are supported
5+
in the latest version.
46

5-
Pylint is a tool that checks for errors in Python code, tries to enforce a
6-
coding standard and looks for code smells. It can also look for certain type
7-
errors, it can recommend suggestions about how particular blocks can be
8-
refactored and can offer you details about the code's complexity.
7+
Pylint analyse your code without actually running it. It checks for errors, enforce a coding
8+
standard, looks for `code smells`_, and can make suggestions about how the code could be refactored.
99

10+
Project that you might want to use alongside pylint include flake8_ (faster and simpler checks
11+
with very few false positives), mypy_, pyright_ or pyre_ (typing checks), bandit_ (security
12+
oriented checks), black_ and isort_ (auto-formatting).
13+
14+
.. _flake8: https://gitlab.com/pycqa/flake8/
15+
.. _bandit: https://github.com/PyCQA/bandit
16+
.. _mypy: https://github.com/python/mypy
17+
.. _pyright: https://github.com/microsoft/pyright
18+
.. _pyre: https://github.com/facebook/pyre-check
19+
.. _black: https://github.com/psf/black
20+
.. _isort: https://pycqa.github.io/isort/
21+
.. _`static code analyser`: https://en.wikipedia.org/wiki/Static_code_analysis
22+
.. _`code smells`: https://martinfowler.com/bliki/CodeSmell.html
23+
24+
Pylint can infer actual values from your code using it's internal code representation (astroid).
25+
If your code is ``import logging as argparse``, Pylint can knows that ``argparse.error(...)``
26+
is in fact a logging call and not an argparse call.
27+
28+
Pylint isn't smarter than you: it may warn you about things that you have
29+
conscientiously done or checks for some things that you don't care about.
30+
During adoption, especially in a legacy project where pylint was never enforced,
31+
it's best to start with the ``--errors-only`` flag, then disable
32+
convention and refactor message with ``--disable=C,R`` and progressively
33+
re-evaluate and re-enable messages as your priorities evolve.
1034

1135
.. toctree::
1236
:maxdepth: 2
1337
:titlesonly:
1438

15-
intro
1639
tutorial
17-
1840
user_guide/index.rst
1941
how_tos/index.rst
2042
messages/index.rst
2143
technical_reference/index.rst
2244
development_guide/index.rst
2345
additional_commands/index.rst
24-
2546
faq
26-
backlinks
27-
support
47+
contact/index
2848
whatsnew/index.rst

‎doc/intro.rst

-58
This file was deleted.

‎doc/support.rst

-17
This file was deleted.

0 commit comments

Comments
 (0)