Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow no type in Numpy param docstrings for mising-param-doc #5231

Merged
merged 3 commits into from
Oct 30, 2021
Merged

Allow no type in Numpy param docstrings for mising-param-doc #5231

merged 3 commits into from
Oct 30, 2021

Conversation

DanielNoord
Copy link
Collaborator

  • Add yourself to CONTRIBUTORS if you are a new contributor.
  • Add a ChangeLog entry describing what your PR does.
  • If it's a new feature, or an important bug fix, add a What's New entry in
    doc/whatsnew/<current release.rst>.
  • Write a good description on what the PR does.

Type of Changes

Type
✓ 🐛 Bug fix

Description

Based on:
https://numpydoc.readthedocs.io/en/latest/format.html#parameters

Closes #5222

@DanielNoord DanielNoord added the False Positive 🦟 A message is emitted but nothing is wrong with the code label Oct 30, 2021
@DanielNoord DanielNoord added this to the 2.12.0 milestone Oct 30, 2021
@DanielNoord DanielNoord mentioned this pull request Oct 30, 2021
Closed
@coveralls
Copy link

Pull Request Test Coverage Report for Build 1402533389

  • 24 of 24 (100.0%) changed or added relevant lines in 1 file are covered.
  • 4 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.02%) to 93.33%
Files with Coverage Reduction New Missed Lines %
pylint/extensions/_check_docs_utils.py 4 91.9%
Totals Coverage Status
Change from base Build 1400384165: -0.02%
Covered Lines: 13726
Relevant Lines: 14707
💛 - Coveralls

Pierre-Sassoulas
Pierre-Sassoulas approved these changes Oct 30, 2021
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@DanielNoord DanielNoord merged commit 1d3a7ff into pylint-dev:main Oct 30, 2021
@DanielNoord DanielNoord deleted the docparams-type branch October 30, 2021 22:33
@DanielNoord DanielNoord mentioned this pull request Oct 31, 2021
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas approved these changes

Assignees
No one assigned
Labels
False Positive 🦟 A message is emitted but nothing is wrong with the code
Projects
None yet
Milestone
2.12.0
Development

Successfully merging this pull request may close these issues.

False positive missing-param-doc on numpy style when : <type> omitted
3 participants
@DanielNoord @coveralls @Pierre-Sassoulas