summaryrefslogtreecommitdiff
path: root/doc/user_guide
Commit message (Collapse)AuthorAgeFilesLines
* Cleanup the FAQ from oudated or duplicated content (#6726)Pierre Sassoulas2022-05-281-0/+2
| | | | Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [doc] Add an explanation on versionning scheme in the FAQPierre Sassoulas2022-05-282-0/+27
| | | | Closes #6676
* [doc] Remove trailing line feeds in generated RSTsPierre Sassoulas2022-05-242-4/+0
|
* [doc] Remove trailing whitespaces in generated all-options.rstPierre Sassoulas2022-05-241-164/+163
|
* [doc] Add generated disclaimer in result of generated documentationPierre Sassoulas2022-05-244-4/+12
|
* [doc] Add the generated rst to the repository for easier reviewPierre Sassoulas2022-05-243-0/+4700
|
* Reorganize the documentation table of content (#6589)Pierre Sassoulas2022-05-2315-79/+103
| | | | | | | * [doc] Reorganize the doc table of content with four levels User, developer, contributor, maintainer. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [doc] Move the naming-style documentation to invalid-name doc (#6669)Pierre Sassoulas2022-05-233-193/+0
| | | | | | Add a '.gitkeep' in user_guide/configuration In order for the directory to exists so pylint_options do not need to create the directory.
* [doc] Move the c-extensions documentation to no-member docPierre Sassoulas2022-05-232-30/+0
|
* [doc] Cleanup the installation/testing/badge documentation in the ReadmePierre Sassoulas2022-05-222-0/+26
|
* Documentation: `consider-using-max-builtin` & `consider-using-min-builtin` ↵Mark Byrne2022-05-221-1/+1
| | | | (#6660)
* Move c-extensions to user guides where it belong (#6659)Pierre Sassoulas2022-05-222-1/+31
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Burst run's documentation between user guide and dev guide,(#6658)Pierre Sassoulas2022-05-221-106/+26
| | | | | | | * [doc] Merge run help from the FAQ to the user guide doc * Rename run to API for dev doc Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Revert "Revert change to names of messages documentation files (#6647)"Daniël van Noord2022-05-193-2/+2
| | | | This reverts commit 13f15ba8c351c023635a33614f721561caa44397.
* [doc] Fix the link to block disable in useless-import-alias related (#6642)Pierre Sassoulas2022-05-191-0/+1
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Revert change to names of messages documentation files (#6647)Daniël van Noord2022-05-193-2/+2
|
* [doc] Modify the automated redirection to user_guidesPierre Sassoulas2022-05-183-3/+3
| | | | | | See discussion: https://github.com/PyCQA/pylint/pull/6628#discussion_r874177297 Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* [doc] Remove unwanted quotation in code example for message controlPierre Sassoulas2022-05-181-36/+36
|
* [refactor] Better link and toc definition for overview of messagesPierre Sassoulas2022-05-183-548/+560
|
* [doc] Move all messages documentation to user_guide/messagesPierre Sassoulas2022-05-184-6/+575
|
* [doc] Remove our own pycharm sectionPierre Sassoulas2022-05-163-49/+2
|
* [doc] Remove our own visual studio code duplicated from the official docPierre Sassoulas2022-05-163-64/+4
|
* [doc] Link to internal document if they existsPierre Sassoulas2022-05-165-13/+25
|
* [doc] Use internal link instead of url for run command linePierre Sassoulas2022-05-162-5/+5
|
* [doc] Better more useful links for ide integrationPierre Sassoulas2022-05-168-275/+280
| | | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Move ide integration to the installation sectionPierre Sassoulas2022-05-162-47/+46
|
* Remove outdated dev/tarball install instructionPierre Sassoulas2022-05-161-12/+23
| | | | | Add title for python 2 compatible version in changelog and add information about installation for older interpreters.
* Correct link to VSCode IDE integration documentation (#6534)Harry2022-05-071-1/+3
| | | | | | | | | | | * Correct link to VSCode IDE integration A link in the user guide claiming to point to VSCode IDE integration documentation was actually pointing to Visual Studio integration documentation. This corrects that link. Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* [spelling] Remove remaining typoes detected by the spelling checkerPierre Sassoulas2022-04-261-7/+7
|
* Create a documentation page with all options (#6346)Daniël van Noord2022-04-163-194/+201
|
* Add a ``--generate-toml-config`` option (#6199)Daniël van Noord2022-04-131-2/+2
|
* Update broken and redirected links across the projectDaniël van Noord2022-04-132-11/+11
|
* Document method of clearing inference cacheJacob Walls2022-03-291-0/+8
|
* Loosen TypeVar name pattern (#5983)Marc Mueller2022-03-261-1/+2
|
* Create a ``TypeVar`` style for ``invalid-name`` (#5894)Daniël van Noord2022-03-241-0/+17
| | | Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
* Add title in running pylint's documentation (#5837)Pierre Sassoulas2022-02-252-39/+47
| | | | | | | | | | | | | * Easier to see title for how to run pylint Refer to #5836 * Clarify exit codes documentation and remove useless stderr output * Add import in the example with a TextReporter Closes #5836 * Move the Reporter explanation where Run is documented
* Lint all files in a directory by expanding arguments (#5682)Matus Valo2022-02-061-0/+4
| | | | | | | * Added --recursive=y/n option and a mention in FAQ and user guide Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Correct reference to `argv` in documentation for `run_pylint()` (#5741)Jacob Walls2022-01-291-1/+1
|
* Allow passing arguments when entry points are used as functions (#5613)Daniël van Noord2021-12-301-0/+14
|
* Update reporters to (allow) use of ``end_line`` and ``end_column`` (#5372)Daniël van Noord2021-11-241-0/+7
| | | | | | * Update reporters to (allow) use end_line and end_column Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* [doc] Add basic documentation for toml configuration filesPierre Sassoulas2021-11-221-0/+3
|
* Update documentation for command-line output options and custom reporters ↵Arianna Y2021-11-191-8/+39
| | | | | | | | | | | (#5335) * Update documentation for command-line output options and custom reporters * Make minor revisions to output documentation and new reporter example * Improve output documentation spelling Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* Clarify syntax in pylint.lint example (#5260)Felix von Drigalski2021-11-131-1/+1
| | | | | * Clarify syntax in pylint.lint example This makes the call non-trivial and demonstrates the syntax more fully.
* Add documentation on adding ``pylint`` to ``pre-commit`` (#5292)Daniël van Noord2021-11-122-0/+47
|
* Fix typos in useless-suppression topicJacob Walls2021-09-061-2/+2
|
* Fix faq.rst:138:undefined label: message-controlPierre Sassoulas2021-08-311-0/+2
|
* Add ``disable-next`` option (#4797)Daniël van Noord2021-08-051-0/+15
| | | | | | | | | | * Add ``disable-next`` option Adding `# pylint: disable-next=msgid` to your file will disable the message for the next line. This closes #1682 * Add documentation, rorganize the FAQ for disable/enable and add ref to the full doc Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Add documentation for useless-suppressionPierre Sassoulas2021-07-311-0/+8
| | | | Closes #4757
* document Jupyter integration (#4714)Marco Edward Gorelli2021-07-181-0/+2
|
* Issue #3747 fix example regex for snakeCase naming style.DudeNr332021-06-291-1/+1
|