diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 22:17:26 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-28 22:17:26 +0200 |
| commit | 8393f3f4523c1acc4c4c5006a56068f0cb3bfc8a (patch) | |
| tree | 188230532bdab445658adeb6a4b37c371c0aaab6 /README.rst | |
| parent | 508e84c3ba2cf36631f7f070c7b26c3e8edf2ad4 (diff) | |
| download | pylint-git-8393f3f4523c1acc4c4c5006a56068f0cb3bfc8a.tar.gz | |
Cleanup the FAQ from oudated or duplicated content (#6726)
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/README.rst b/README.rst index 41c4cf585..67fd09c15 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,8 @@ .. _`Pylint`: https://pylint.pycqa.org/ +.. This is used inside the doc to recover the start of the introduction + .. image:: https://github.com/PyCQA/pylint/actions/workflows/tests.yaml/badge.svg?branch=main :target: https://github.com/PyCQA/pylint/actions @@ -85,9 +87,13 @@ pydocstringformatter_ (automated pep257). .. _pydocstringformatter: https://github.com/DanielNoord/pydocstringformatter .. _isort: https://pycqa.github.io/isort/ +.. This is used inside the doc to recover the end of the introduction + Install ------- +.. This is used inside the doc to recover the start of the short text for installation + For command line use, pylint is installed with:: pip install pylint @@ -97,9 +103,13 @@ It can also be integrated in most editors or IDEs. More information can be found .. _in the documentation: https://pylint.pycqa.org/en/latest/user_guide/installation/index.html +.. This is used inside the doc to recover the end of the short text for installation + Contributing ------------ +.. This is used inside the doc to recover the start of the short text for contribution + We welcome all forms of contributions such as updates for documentation, new code, checking issues for duplicates or telling us that we can close them, confirming that issues still exist, `creating issues because you found a bug or want a feature`_, etc. Everything is much appreciated! @@ -108,9 +118,10 @@ Please follow the `code of conduct`_ and check `the Contributor Guides`_ if you make a code contribution. .. _creating issues because you found a bug or want a feature: https://pylint.pycqa.org/en/latest/contact.html#bug-reports-feedback -.. _code of conduct: https://github.com/Pierre-Sassoulas/pylint/blob/main/CODE_OF_CONDUCT.md +.. _code of conduct: https://github.com/PyCQA/pylint/blob/main/CODE_OF_CONDUCT.md .. _the Contributor Guides: https://pylint.pycqa.org/en/latest/development_guide/contribute.html +.. This is used inside the doc to recover the end of the short text for contribution Show your usage ----------------- |