summaryrefslogtreecommitdiff
path: root/doc/exts
Commit message (Collapse)AuthorAgeFilesLines
* Make sure a ``tool`` table is created in ``toml`` generation (#8638)Daniël van Noord2023-04-301-1/+3
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Drop support for Python 3.7 (#8609)Marc Mueller2023-04-241-6/+1
| | | | | * Drop support for Python 3.7 * Update py-version + classifier * Update functional tests
* [PyCQA migration] Upgrade links to the repositories in code and doc (#8514)Pierre Sassoulas2023-03-294-9/+9
|
* Remove all old code related to ``optparse`` config parsing. (#8405)Daniël van Noord2023-03-081-14/+9
| | | | | * Remove all old config parsing code * Temporarily disable a test
* Documentation: Order of messagesStavros Ntentos2023-02-221-2/+2
| | | | | | | | | | | | | | | In https://github.com/PyCQA/pylint/pull/7162, "we decreed" that the `bad_code` goes first, then the `good_code`. Fixup current changes, to revert "back to standards". Additionally, tackle the comment here https://github.com/PyCQA/pylint/pull/8287#issuecomment-1437983737 "Message emitted" is technically still code (`%-formatting`); let us make it stand out properly. Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com>
* Add support for more than one code file in the documentation examplesDaniel van Noord2023-02-201-52/+85
| | | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* [typing] Use __future__ annotations where possible (#8264)Pierre Sassoulas2023-02-121-7/+9
|
* [old_names doc] Fix the autogenerated pages for renamed messagesPierre Sassoulas2023-02-031-2/+2
|
* [style] Limit line length and complexity using flake8 (#8064)Pierre Sassoulas2023-01-161-2/+2
| | | 125 is a good start. The check was activated in pylint with value = 100, but flake8 is less lenient than pylint and does not make any exceptions (for docstrings, strings and comments in particular).
* Add default_enabled option to optional message dict (#7629)Marc Mueller2022-10-251-0/+10
|
* Finish unfinished typing in non core directories (#7443)Daniël van Noord2022-09-092-4/+5
| | | | | | | | * Add typing to setup calls in documentation folder * Finish some incomplete typing signatures in script * Add typing to unfinished signatures in the tests directory
* Turn on ``check-untyped-defs`` in ``mypy`` (#7407)Daniël van Noord2022-09-091-15/+43
|
* Fix config section name in doc (#7186)Tushar Sadhwani2022-07-141-1/+1
| | | The change should also be reflected in rendered docs, like in `doc/user_guide/configuration/all-options.rst`, but I think those are generated from this doc.
* In "Messages Overview", show the `bad_code` first (#7162)Stavros Ntentos2022-07-111-1/+1
| | | | | | | | It makes more sense to _first define the problem_, then solve it. Mentions issue https://github.com/PyCQA/pylint/issues/7143 Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Add support of sharing message in multiple checkers. Fix DeprecatedChecker ↵Matus Valo2022-06-161-20/+62
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | example (#6693) * Move message definitions from DeprecatedMixin * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Added typing and fixed unittests * Make DEPRECATED_MSGS and DEPRECATED_IMPORT_MSG class variables to make pylint happy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Introduce shared messages * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Change Message codes in DeprecatedMixin to W49XX * Make mypy happy * Make pylint happy * Add support for building documentation for shared messages * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Make isort happy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Circuvent isort * Move shared to extra message options and fix tests * Update deprecation_checker example * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update doc/exts/pylint_messages.py Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> * Update doc/exts/pylint_messages.py Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> * Make messages static class attributes * Keep MessageDefinition backward compatible * Apply suggestions from code review Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* [doc] Fix the assert for placeholders following #6839 (#6873)Pierre Sassoulas2022-06-061-3/+15
|
* Remove redundant options documentation and improve formatting (#6665)Daniël van Noord2022-06-063-8/+13
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* [doc] Add `trailing-newlines` example (#6839)Harutaka Kawamura2022-06-051-5/+3
| | | Use literalinclude for including python file in examples.
* [doc] Add a check for partially completed documentationPierre Sassoulas2022-05-281-0/+3
|
* [refactor] Create a function to get the messages' data pathPierre Sassoulas2022-05-281-13/+22
|
* [refactor] Messages data generation for the documentationPierre Sassoulas2022-05-281-43/+54
|
* Cleanup the FAQ from oudated or duplicated content (#6726)Pierre Sassoulas2022-05-281-1/+2
| | | | Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* Generate the data message directories with an advert for potential ↵Pierre Sassoulas2022-05-261-8/+19
| | | | contributors (#6702)
* [doc] Remove trailing line feeds in generated RSTsPierre Sassoulas2022-05-242-4/+9
|
* [doc] Remove trailing whitespaces in generated all-options.rstPierre Sassoulas2022-05-241-1/+3
|
* [doc] Add generated disclaimer in result of generated documentationPierre Sassoulas2022-05-244-9/+24
|
* Reorganize the documentation table of content (#6589)Pierre Sassoulas2022-05-233-6/+3
| | | | | | | * [doc] Reorganize the doc table of content with four levels User, developer, contributor, maintainer. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* Some initial line wrapping of docstrings (#6672)Daniël van Noord2022-05-232-3/+5
|
* Update ``pydocstringformatter`` to ``0.6.0`` (#6671)Daniël van Noord2022-05-231-1/+1
|
* Revert "Revert change to names of messages documentation files (#6647)"Daniël van Noord2022-05-191-1/+1
| | | | This reverts commit 13f15ba8c351c023635a33614f721561caa44397.
* Revert change to names of messages documentation files (#6647)Daniël van Noord2022-05-191-1/+1
|
* Run ``linkcheck`` and message generation in quiet mode (#6649)Daniël van Noord2022-05-191-1/+0
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* [doc] Smaller description of the optional checker messagesPierre Sassoulas2022-05-181-2/+2
| | | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* [refactor] Better link and toc definition for overview of messagesPierre Sassoulas2022-05-181-13/+18
|
* [doc] Move all messages documentation to user_guide/messagesPierre Sassoulas2022-05-181-1/+1
|
* [doc] Lazily write files for repeated doc buildsPierre Sassoulas2022-05-161-1/+23
|
* [refactor] Factorize the message type in loopPierre Sassoulas2022-05-161-3/+3
|
* [refactor] Create a function for writting a message's .rstPierre Sassoulas2022-05-161-16/+20
|
* Use main instead of master as main checker name (#6569)Daniël van Noord2022-05-101-1/+1
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Create a documentation page with all options (#6346)Daniël van Noord2022-04-161-0/+186
|
* Deprecate most methods of ``_ArgumentsProvider``Daniël van Noord2022-04-121-9/+14
|
* Docs: Generate note about extensions module in message documentation (#6058)Matus Valo2022-03-311-2/+31
| | | | | | | * Improve note about plugins * Add link to checker in messages documentation Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Update configuration of pre-commit hooks and toolsDaniël van Noord2022-03-252-5/+11
|
* Add a pre-commit hook to check the copyright noticePierre Sassoulas2022-03-243-3/+5
| | | | | Fix the existing file so they have a notice. No header for setup.py or examples or doc
* Simplify hard to maintain copyright noticePierre Sassoulas2022-03-243-0/+3
| | | | | | git is the source of truth for the copyright, copyrite (the tool) was taking exponentially longer with each release, and it's polluting the code with sometime as much as 50 lines of names.
* Set up system of code examples and details for message documentation (#5934)Daniël van Noord2022-03-231-1/+72
|
* Upgrade ``pydocstringformatter`` to ``0.5.0`` (#5910)Daniël van Noord2022-03-131-0/+2
|
* Update ``pydocstringformatter`` to 0.4.0 (#5787)Daniël van Noord2022-02-102-4/+4
|
* Fix duplicate names of ``Pylint Messages`` in docs (#5744)Daniël van Noord2022-02-071-1/+5
| | | | | Also add tbump step to upgrade the placeholder markdown, and an auto generation comment. Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Create separate documentation page for each message (#5396)Daniël van Noord2022-01-281-0/+226
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>