Unexpected changes occur when fixing D208 and D209 on the same line

When ruff fixes both D208 (over-indentation) and D209 (new-line-after-last-paragraph) on the same line, it results in unexpected changes.
I share the minimum test case.

Target code:

def test_func(a: int) -> None:
    """Minimum test case.

    Parameters
    ----------
    a : int
        A parameter."""
    pass

Settings in pyproject.toml:

[tool.ruff]
show-fixes = true

[tool.ruff.lint]
select = ["D"]

[tool.ruff.lint.pydocstyle]
convention = "numpy"

Run above command:

ruff check target.py --fix

Expected results:

def test_func(a: int) -> None:
    """Minimum test case.

    Parameters
    ----------
    a : int
        A parameter.
    """
    pass

but, actual:

def test_func(a: int) -> None:
    """Minimum test case.

    Parameters
    ----------
    a : int
    A parameter.
    """
    pass

Thanks. I think the issue here is that D208 should not be raised because it also doesn't raise for:

def test_func(a: int) -> None:
    """Minimum test case.

    Parameters
    ----------
    a : int
        A parameter.
    """
    pass

I added this sentence to pyproject.toml as a temporary solution in my project.

[tool.ruff.lint]
unfixable = [
    "D208",
]

I suggest treating D208 as "--unsafe-fixes".

Hi, I would like to work on this if no one has taken it.

@MichaReiser

@MichaReiser I'm closing this issue considering #13372 is merged but if that only solves a part of this issue, feel free to re-open.

Navigation Menu

Repository navigation

Unexpected changes occur when fixing D208 and D209 on the same line #13260

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Unexpected changes occur when fixing D208 and D209 on the same line #13260

Description

Activity

MichaReiser commented on Sep 6, 2024

kubotty commented on Sep 11, 2024

ukyen8 commented on Sep 14, 2024

dhruvmanila commented on Oct 3, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions