Rewrite and synthetis the installation doc #6622
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pierre-Sassoulas
force-pushed
the
rewrite-the-installation-doc
branch
from
4f3e2e5 to
71e6045
Compare
Pull Request Test Coverage Report for Build 2332644728
💛 - Coveralls |
DanielNoord
requested changes
May 16, 2022
| | fatal | pylintCategorySeverity.fatal | Error | | ||
| +----------------------+-----------------------------------+------------------+ | ||
|
|
||
| .. _Pylint command line arguments: https://pylint.pycqa.org/en/latest/user_guide/run.html#command-line-options |
There was a problem hiding this comment.
We should probably use an internal link here.
There was a problem hiding this comment.
Nice catch, I just copy pasted / burst the previous content without checking.
doc/user_guide/installation.rst
Outdated
Comment on lines
22
to
26
| If a newer version does not work for you, we do not maintain pylint for EOL python, | ||
| so the best available pylint might be an old version that works with your old interpreter but | ||
| without the bug fixes and feature of latest pylints. |
There was a problem hiding this comment.
Suggested change
| If a newer version does not work for you, we do not maintain pylint for EOL python, | |
| so the best available pylint might be an old version that works with your old interpreter but | |
| without the bug fixes and feature of latest pylints. |
A bit redundant I think.
doc/user_guide/installation.rst
Outdated
|
|
||
| Pylint should be easily installable using pip. | ||
| NB: You can also use ``conda`` or your system package manager on debian based OS. | ||
| There package manager lag a little behind as it's maintained by a separate entity. |
There was a problem hiding this comment.
Suggested change
| There package manager lag a little behind as it's maintained by a separate entity. | |
| However, the available version can lag behind a little as it's maintained by a separate entity. |
Pierre-Sassoulas
force-pushed
the
rewrite-the-installation-doc
branch
2 times, most recently
from
c7119c5 to
255deb5
Compare
DanielNoord
requested changes
May 16, 2022
doc/user_guide/installation.rst
Outdated
| - gedit_ | ||
| - `Jupyter Notebook`_ | ||
| - Komodo_ | ||
| - PyCharm_ :ref:`the section below <pylint_in_pycharm>` |
There was a problem hiding this comment.
Suggested change
| - PyCharm_ :ref:`the section below <pylint_in_pycharm>` | |
| - PyCharm_, see our:ref:`tutorial <pylint_in_pycharm>` |
There was a problem hiding this comment.
I removed the link to the IDE, if you're searching a pylint plugin for it you don't need to learn about your own IDE.
Pierre-Sassoulas
force-pushed
the
rewrite-the-installation-doc
branch
from
255deb5 to
0039e90
Compare
Comment on lines
+6
to
+12
| .. warning:: | ||
| If you're reading this doc and are actually using flymake please | ||
| open a support question at https://github.com/PyCQA/pylint/issues/new/choose | ||
| and tell us, we don't have any maintainers for emacs and are thinking about | ||
| dropping the support. | ||
|
|
||
| .. TODO 3.0, do we still need to support flymake ? |
There was a problem hiding this comment.
Added a warning here.
Comment on lines
6
to
9
| See external documentation: | ||
|
|
||
| - Linting python: https://code.visualstudio.com/docs/python/linting | ||
| - Pylint Extension: https://marketplace.visualstudio.com/items?itemName=ms-python.pylint |
There was a problem hiding this comment.
Added the external doc here, I'm hesitating to simply remove our own doc and only link one of the link.
There was a problem hiding this comment.
I'd be okay with removing it. There is a bit of duplication with other sections as well.
There was a problem hiding this comment.
I removed the two that had better doc elsewhere.
Pierre-Sassoulas
force-pushed
the
rewrite-the-installation-doc
branch
from
2b91edf to
a820d1e
Compare
DanielNoord
reviewed
May 16, 2022
Comment on lines
6
to
9
| See external documentation: | ||
|
|
||
| - Linting python: https://code.visualstudio.com/docs/python/linting | ||
| - Pylint Extension: https://marketplace.visualstudio.com/items?itemName=ms-python.pylint |
There was a problem hiding this comment.
I'd be okay with removing it. There is a bit of duplication with other sections as well.
Pierre-Sassoulas
force-pushed
the
rewrite-the-installation-doc
branch
from
470ec5b to
c5d29c5
Compare
DanielNoord
reviewed
May 16, 2022
| - :ref:`TextMate <pylint_in_textmate>` | ||
| - Vim_ | ||
| - `Visual Studio Code`_ in the `Preferences -> Settings` menu | ||
| - `Visual Studio`_ in the `Python > Run PyLint` command on a project's context menu. |
There was a problem hiding this comment.
Wasn't there a link to the pylint extension here as well?
Add title for python 2 compatible version in changelog and add information about installation for older interpreters.
Co-authored-by: Daniël van Noord <[email protected]>
Pierre-Sassoulas
force-pushed
the
rewrite-the-installation-doc
branch
from
c5d29c5 to
1c1de9a
Compare
DanielNoord
approved these changes
May 16, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Changes
Description
Add title for python 2 compatible version in changelog and add information
about installation for older interpreters. Refactor ide integration and put it in
the installation part for clarity.
Small reviewable part of #6589 and follow-up to #6613