[Doc] Create a contact section and cleanup the introduction #6613
Conversation
| @@ -1,14 +0,0 @@ | |||
|
|
|||
| Some projects using Pylint | |||
There was a problem hiding this comment.
Removed because it's super outdated and we're not some kind of startup trying to secure funding so it's noise.
Pull Request Test Coverage Report for Build 2325150764
💛 - Coveralls |
Pierre-Sassoulas
force-pushed
the
create-a-contact-section
branch
from
7e2868d to
604d71b
Compare
| @@ -1,58 +0,0 @@ | |||
| .. -*- coding: utf-8 -*- | |||
|
|
|||
| ============== | |||
There was a problem hiding this comment.
Is it worth breaking old links for this? I think we should add a redirect.
There was a problem hiding this comment.
I've searched a way to do it in the configuration file but I don't think it's possible. Do you happen to know how to do it ?
There was a problem hiding this comment.
No, I have never done this, but it should be possible. At least with a Sphinx extension.
There was a problem hiding this comment.
It seems it should be possible to do it with readthedoc conf directly but after 60+mn I just took an extension to do it.
Co-authored-by: Daniël van Noord <[email protected]>
Co-authored-by: Daniël van Noord <[email protected]>
| with very few false positives), mypy_, pyright_ or pyre_ (typing checks), bandit_ (security | ||
| oriented checks), black_ and isort_ (auto-formatting), autoflake_ (automated removal of | ||
| unused import or variable), pyupgrade_ (automated upgrade to newer python syntax) and | ||
| pydocstringformatter_ (automated pep257). |
There was a problem hiding this comment.
It's your last chance to give this tool a cool name, Daniel.
There was a problem hiding this comment.
Ship has sailed I think 😄 And I really don't know anything better.
|
|
||
| .. _`astroid`: https://github.com/PyCQA/astroid | ||
|
|
||
| 2.4 What versions of Python is Pylint supporting? |
There was a problem hiding this comment.
I think it wouldn't hurt to keep this in the FAQ. As I can easily see people wondering about this and the FAQ would be one the first places I would look for this information.
There was a problem hiding this comment.
I'm going to remove the faq or create two faqs, one for users and one for developer. We might as well document the pylint version vs python interpreter... or maybe pip is handling that and you don't need to know ? Do you mind if we do that in the following merge request ?
Co-authored-by: Daniël van Noord <[email protected]>
| @@ -43,8 +46,16 @@ | |||
| "pylint_options", | |||
| "sphinx.ext.autosectionlabel", | |||
| "sphinx.ext.intersphinx", | |||
| "sphinx_reredirects", | |||
There was a problem hiding this comment.
This project doesn't seem very well maintained. After the initial release of 0.0.1 a lot of open issue were never dealt with.
Are we sure want to use it?
There was a problem hiding this comment.
Yeah 0.0.1 does not inspire confidence. But the current version is working well enough, and it's just a dict of simple redirect so worst case scenario we can still switch later if required.
There was a problem hiding this comment.
Type of Changes
Description
Small reviewable extract from #6589