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.

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

False negative differing-type-doc for Google-style docstring #10237

Open
void-rooster opened this issue Feb 18, 2025 · 0 comments
Open

False negative differing-type-doc for Google-style docstring #10237

void-rooster opened this issue Feb 18, 2025 · 0 comments
Labels
False Negative 🦋 No message is emitted but something is wrong with the code Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@void-rooster
Copy link

void-rooster commented Feb 18, 2025

Bug description

"""Fake function."""

from shapely.geometry import Point

def test(x: Point) -> int:
    """Fake function.

    Args:
        x (tuple[float, float]): X.

    Returns:
        int: Integer.
    """
    return 5

Command used

pylint --load-plugins=pylint.extensions.docparams test.py

Pylint output

************* Module xxxxxx
test.py: 5: [W0613 (unused-argument), test] Unused argument 'x'

------------------------------------------------------------------
Your code has been rated at 6.67/10 (previous run: 6.67/10, +0.00)

Expected behavior

Possible duplicate of #6478 . I expect the difference between Point in function signature and tuple[float, float] in documentation to raise differing-type-doc.

Pylint version

pylint 3.3.4
astroid 3.3.8
Python 3.9.21
[GCC 10.2.1 20210110]
@void-rooster void-rooster added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Feb 18, 2025
@zenlyj zenlyj added False Negative 🦋 No message is emitted but something is wrong with the code Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
False Negative 🦋 No message is emitted but something is wrong with the code Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Development

No branches or pull requests

2 participants