summaryrefslogtreecommitdiff
path: root/doc/development_guide
Commit message (Collapse)AuthorAgeFilesLines
* [Doc] Minor fixup in launching_test.rstLucas Cimon2023-05-051-1/+1
|
* [cleanup] Upgrade more doc following the PyCQA migrationPierre Sassoulas2023-03-315-7/+7
|
* [PyCQA migration] Upgrade links to the repositories in code and doc (#8514)Pierre Sassoulas2023-03-293-20/+20
|
* [release doc] Add a paragraph for label maintenance (#8422)Pierre Sassoulas2023-03-101-0/+4
| | | | | Refs #8420 Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [deprecation] epylint removal for pylint 3.0.0 (#8400)Pierre Sassoulas2023-03-082-24/+1
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* [release documentation] Upgrade for post release branch deletion (#8399)Pierre Sassoulas2023-03-081-1/+5
|
* Document the governance model and the path to maintainership (#8329)Pierre Sassoulas2023-02-242-0/+111
| | | | Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [PR documentation] Add advice to keep the pull requests small (#8330)Pierre Sassoulas2023-02-231-12/+20
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Don't use deprecated attribute in example test (#8231)jessebrennan2023-02-081-1/+1
|
* Add missing import to example test (#8228)jessebrennan2023-02-071-0/+1
|
* [doc] Use the real URL address of pylint's read the doc projectPierre Sassoulas2023-02-061-1/+1
|
* docs: fix typo (#8092)Mike Frysinger2023-01-211-1/+1
|
* Bump flake8 from 5.0.4 to 6.0.0 (#7859)dependabot[bot]2022-12-061-2/+3
| | | | | | | | | | | | | | | | | | | | | Bumps [flake8](https://github.com/pycqa/flake8) from 5.0.4 to 6.0.0. - [Release notes](https://github.com/pycqa/flake8/releases) - [Commits](https://github.com/pycqa/flake8/compare/5.0.4...6.0.0) --- updated-dependencies: - dependency-name: flake8 dependency-type: direct:production update-type: version-update:semver-major ... * Fix regression with inline comment * Update flake8 config * doc about required python interpreters for contributors Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
* Rephrase Functional tests section in writing_test docs page (#7870)orSolocate2022-11-301-10/+11
|
* [github actions] Upgrade the documentation to handle cherry-pick conflictsPierre Sassoulas2022-11-191-0/+8
|
* Deprecation following the separation of emacs related file to ↵Pierre Sassoulas2022-11-191-2/+1
| | | | | | | https://github.com/emacsorphanage/pylint (#7783) Co-authored-by: Jonas Bernoulli <jonas@bernoul.li> Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [release process] Add a github actions to backport fix automatically (#7776)Pierre Sassoulas2022-11-161-10/+5
| | | Based on https://github.com/tibdex/backport which seems awfully conveniant.
* Correct documentation about running primer locallyJacob Walls2022-11-131-5/+14
|
* Add new `feature` category for changelog entries (#7659)Marc Mueller2022-10-221-3/+3
|
* Add "breaking change" and "user action" fragment types (#7588)Andreas Finkler2022-10-101-1/+1
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* A collection of documentation updates (#7512)Daniël van Noord2022-09-221-0/+2
| | | | | | | | | | | | | | | | | * Update ``exec--used`` documentation Closes https://github.com/PyCQA/pylint/issues/7039 * Be more explicit about third party plugins Closes https://github.com/PyCQA/pylint/issues/6900 * Document behaviour of config file generators Refs. https://github.com/PyCQA/pylint/issues/7478 Co-authored-by: Mark Byrne <31762852+mbyrnepr2@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Improve docs clarity on loading custom checkers - FIXED (#7502)Drummond Ogilvie2022-09-201-4/+22
| | | | | | | | | | | | | | | | | | | | * Improve docs clarity on loading custom checkers Whilst the docs on testing custom checkers do touch on the fact the module has to be in your load path, there are some restrictions that were not made clear before. Specifically, the init-hook configuration item (which is often used explicitly to change the sys.path) is not automatically sufficient. If the init hook is in a file, but the load-plugins argument is passed in the CLI, then the plugins are loaded before the init-hook has run, and so will not be imported. In this case, the failure can also be silent, so the outcome is a lint that will simply not contain any information from the checker, as opposed to a run that will error. This corner case may merit fixing in a separate PR, that is to be confirmed. Closes #7264 Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* [doc] New release procedure for towncrier in #6974 (#7198)Pierre Sassoulas2022-07-181-11/+10
|
* Update documentation for usage of `towncrier`DudeNr332022-07-171-3/+9
|
* [doc] Separate false postives and bug/crashes in contributor doc (#7182)Pierre Sassoulas2022-07-131-3/+5
|
* Links in the documentation to help triaging and labelling the backlog (#7179)Pierre Sassoulas2022-07-131-2/+48
| | | | | | | In order to easily be able to do maintenance task Closes #7101 Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Replace deprecated uses of `do_exit` with `exit`Jacob Walls2022-06-231-2/+2
|
* [release doc] Add instruction for readthedoc cleanup (#6977)Pierre Sassoulas2022-06-181-0/+3
|
* [Docs] Move Message definition to separate section, add extra options (#6947)Matus Valo2022-06-171-24/+55
| | | | | | | | | | | | | | | | | | | | | | | | * [Docs] Move Message difinition to separate section, add extra options * Apply suggestions from code review Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Apply suggestions from code review Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fix sphinx errors Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Add small code sample to custom checker documentation (#6960)epenet2022-06-161-1/+6
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Bump pylint to 2.14.0, update changelogv2.14.0Pierre Sassoulas2022-06-011-8/+3
|
* [doc] Add a check for changelogs and fix the issues encountered (#6735)Pierre Sassoulas2022-06-011-1/+1
|
* [doc] Better documentation for contributor installationPierre Sassoulas2022-05-313-44/+45
|
* Remove redundant second batch of old primerDaniël van Noord2022-05-301-4/+1
|
* Upgrade documentation around the changelogPierre Sassoulas2022-05-282-10/+10
| | | | | | | | We do not upgrade the scripts at the same time because we want to avoid conflicts with main and need to merge the file moved for that. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [doc] Add an explanation on versionning scheme in the FAQPierre Sassoulas2022-05-284-0/+14
| | | | Closes #6676
* [doc] Remove the numbering and outdated question from the FAQPierre Sassoulas2022-05-281-0/+2
|
* Reorganize the documentation table of content (#6589)Pierre Sassoulas2022-05-2316-12/+677
| | | | | | | * [doc] Reorganize the doc table of content with four levels User, developer, contributor, maintainer. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [doc] Activate the nitpicky option in sphinx build (#6650)Pierre Sassoulas2022-05-221-3/+3
| | | | | | | This will warn about all missing references * Remove references that don't work Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* [doc] Cleanup the installation/testing/badge documentation in the ReadmePierre Sassoulas2022-05-226-92/+154
|
* [doc] Uniformize the introduction for Readme and docPierre Sassoulas2022-05-221-0/+2
|
* Burst run's documentation between user guide and dev guide,(#6658)Pierre Sassoulas2022-05-224-0/+113
| | | | | | | * [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>
* [doc] Add a job to install the dependencies before build-htmlPierre Sassoulas2022-05-161-2/+3
|
* [doc] Use a saved environment, do not always read all filesPierre Sassoulas2022-05-161-2/+6
| | | | In the CI we have a fresh environnement, so this option is just making repeated build slower locally
* [Doc] Create a contact section and cleanup the introduction (#6613)Pierre Sassoulas2022-05-151-45/+0
| | | | | | | * Add a mechanism for redirection * Upgrade cache so the new requirements are properly installed Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Replace `pip install -e` with `pip install -r requirements_test_min.txt` (#6588)Edward K. Ream2022-05-121-2/+4
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Fix typo for script directoryJacob Walls2022-04-291-1/+1
|
* Fix typos in profiling documentJacob Walls2022-04-291-3/+3
|
* Fix the pyenchant dependencie following #6440Pierre Sassoulas2022-04-281-1/+1
| | | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Update broken and redirected links across the projectDaniël van Noord2022-04-132-10/+10
|