summaryrefslogtreecommitdiff
path: root/pylint/extensions/_check_docs_utils.py
Commit message (Collapse)AuthorAgeFilesLines
* [PyCQA migration] Upgrade links to the repositories in code and doc (#8514)Pierre Sassoulas2023-03-291-2/+2
|
* Use UninferableBase instead of UninferableDaniel van Noord2023-03-071-3/+3
|
* Fix ``missing-param-doc`` for escaped underscores (#7878)Dani Alcala2022-12-041-1/+1
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Turn on ``mypy`` strict mode 🎉 (#7448)Daniël van Noord2022-09-091-1/+1
| | | | | | | | | | * Ignore subclasses of Any * Add ignores for imported code and remove casts * Add disables for uninferable return values * Turn on ``mypy`` strict mode
* Fix and refactors for ``docparams`` extension (#7398)Daniël van Noord2022-09-041-13/+27
| | | | | | | | | | | * Fix and refactors for ``docparams`` extension The ``re_only_desc`` regex did not match for white and characters after ``\n``, so some description-only lines weren't getting matched. In addition, lookaheads were added to ``re_param_line`` (i.e. make sure the type group is not followed by a new line (``\n``)). Lastly, named groups (ala Perl regular expressions) were added for slightly improved clarity. Co-authored-by: Hendry, Adam <adam.grant.hendry@gmail.com>
* Allow lists of default values in parameter documentation for ``Numpy`` (#7149)Daniël van Noord2022-07-081-3/+14
|
* Add typing to extensions (#6893)Daniël van Noord2022-06-091-1/+2
|
* Fix a crash in the ``docparams`` extension when raising the result of a ↵Jacob Walls2022-05-311-0/+2
| | | | function (#6767)
* Add typing to ``_check_docs_utils``Daniël van Noord2022-05-241-45/+45
|
* Update ``pydocstringformatter`` to ``0.6.0`` (#6671)Daniël van Noord2022-05-231-1/+0
|
* Move no-self-use to optional extension (#6448)Marc Mueller2022-05-051-1/+0
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Use ``python-typing-update`` on ``pylint/extensions`` directory (#6308)Daniël van Noord2022-04-141-7/+8
|
* Handle asterisks better in Sphinx and Google style docstringsDaniël van Noord2022-04-071-2/+5
|
* Add a pre-commit hook to check the copyright noticePierre Sassoulas2022-03-241-1/+1
| | | | | 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-241-21/+1
| | | | | | 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.
* Remove uses of ``NodeNG.doc`` in favour of ``doc_node``Daniël van Noord2022-03-151-5/+7
|
* Upgrade ``pydocstringformatter`` to ``0.5.0`` (#5910)Daniël van Noord2022-03-131-1/+3
|
* Update ``pydocstringformatter`` to 0.4.0 (#5787)Daniël van Noord2022-02-101-5/+5
|
* [pre-commit.ci] pre-commit autoupdate (#5758)pre-commit-ci[bot]2022-02-011-14/+14
| | | | | | | | | | | | | * [pre-commit.ci] pre-commit autoupdate updates: - [github.com/psf/black: 21.12b0 → 22.1.0](https://github.com/psf/black/compare/21.12b0...22.1.0) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Add ``future=True`` to all ``NodeNG.frame`` calls (#5621)Daniël van Noord2022-01-101-1/+1
| | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Format docstrings with ``pydocstringformatter``Daniël van Noord2022-01-021-4/+2
|
* Fix typos accross the whole codebase (#5575)Pierre Sassoulas2021-12-211-10/+14
| | | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* Fix typos over the whole codebase (#5540)Kian Meng, Ang2021-12-171-1/+1
| | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Enable missing-raises-doc to understand class hierarchies (#5278)kasium2021-12-151-14/+15
| | | | | | | | | | | | | Before, missing-raises-doc could not understand class hierarchies but just compared names. So, when a method documented a raise of a parent class, but a child exception was raised, the check failed. With this change, if the name compare doesn't help, the exception class hierarchy is checked. For that, possible_exc_types was changed to return classes instead of names Resolved #4955 Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Fix incorrect classification of property docstrings in Numpy-style (#5498)Daniël van Noord2021-12-121-21/+31
|
* Bump pylint to 2.12.2, update changelogv2.12.2Pierre Sassoulas2021-12-031-0/+1
|
* Require ``\`` for asterisks in Sphinx-style parameter docstrings (#5464)Daniël van Noord2021-12-031-3/+5
| | | | Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* #5452: Fix false positive missing-doc-param from multi-line Google-st… (#5459)allanc652021-12-031-10/+3
| | | | | * #5452: Fix false positive missing-doc-param from multi-line Google-style docstrings. Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
* Bump pylint to 2.12.0, update changelogv2.12.0Pierre Sassoulas2021-11-251-1/+2
| | | | Closes #5250
* Remove accidental print statementDaniël van Noord2021-10-311-1/+0
|
* Allow no type in Numpy param docstrings for ``mising-param-doc`` (#5231)Daniël van Noord2021-10-311-4/+35
| | | | | This closes #5222 See https://numpydoc.readthedocs.io/en/latest/format.html#parameters for reference
* Fix asterisks parsing of ``mising-param-doc`` (#5175)Daniël van Noord2021-10-181-3/+3
| | | Closes #3733
* Properly identify undocumented parameters and add new message called ↵Konstantina Saketou2021-10-101-5/+12
| | | | | | | | | | | | | | | | | | | missing-any-param-doc (#5097) * Correctly identify parameters with no doc and add new message This commit fixes the problem where non documented parameters where not being identified properly. Also, it adds a new message called ``missing-any-param-doc`` for when a function has no parameter and type doc at all. Adds new test cases for the ``missing-param-doc`` and ``missing-type-doc`` messages and tests for the new message ``missing-any-param-doc``. * Replace old messages with the new one where needed Fix pylint's code where the new message where needed in other files instead of triggering both missing-param-doc and missing-type-doc. Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Bump pylint to 2.11.0, update changelogv2.11.0Pierre Sassoulas2021-09-161-0/+1
|
* Add ``Consider-using-f-string`` checker (#4796)Daniël van Noord2021-08-301-86/+58
| | | | | | | | | | | | | | | | * Add ``consider-using-f-string`` checker This adds a checker for normal strings which are formatted with ``.format()`` or '%'. The message is a convention to nudge users towards using f-strings. This closes #3592 * Update pylint code to use f-strings After adding `consider-using-f-strings` the codebase showed numerous cases of formatting which could be f-strings. This commit changes most of these to become f-strings, or adds ignores. * Apply suggestions from code review Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Bump pylint to 2.10.2-dev0, update changelogAshley Whetter2021-08-201-1/+1
|
* Bump pylint to 2.10.1, update changelogv2.10.1Ashley Whetter2021-08-201-1/+1
|
* Bump pylint to 2.10.0, update changelogv2.10.0Pierre Sassoulas2021-08-201-1/+1
|
* Use alias for astroid.nodes 03 (#4866)Marc Mueller2021-08-181-14/+15
| | | | | | | | | * Use alias for astroid nodes 03 * Resolve name conflicts * Apply suggestions from code review Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
* Bump pylint to 2.9.4, update changelogv2.9.4Pierre Sassoulas2021-07-201-1/+1
|
* Bump pylint to 2.9.3, update changelogv2.9.3Pierre Sassoulas2021-07-011-1/+1
|
* Fix copyright links (#4647)Marc Mueller2021-07-011-1/+1
| | | | * Fix link in license header * Update link to astroid bump_changelog
* Bump pylint to 2.9.0, update changelog, add python 3.10 to package metav2.9.0Pierre Sassoulas2021-06-291-1/+1
|
* Make a smarter check to avoid 'useless-type-doc' false positivePierre Sassoulas2021-06-251-4/+0
|
* Fix useless-type-doc false positive when args exist in the docstringPierre Sassoulas2021-06-251-0/+4
| | | | | Closes #4117 Closes #4593
* Add a '__repr__' function in DocstringPierre Sassoulas2021-06-251-0/+3
|
* Bump pylint to 2.9.0-dev1, update changelogPierre Sassoulas2021-06-171-0/+1
|
* Fix existing codeMarc Mueller2021-06-101-2/+2
|
* Rename copying to license and upgrade the setup.cfg (#4338)Pierre Sassoulas2021-04-111-1/+1
|
* Apply copyrite --contribution-thresholdPierre Sassoulas2021-02-211-1/+2
|