seemingly correct format reformatted?

[jjenniferdai]

hi, docformatter edits this seemingly correct format, is there something we're missing?

Lightning-AI/pytorch-lightning@6d12d69

Adding an extra line (Lightning-AI/pytorch-lightning#9422 (comment)) seems to make docformatter happy, was there something off with the original though? Thank you!

[merwok]

Doesn’t reST require a blank line between the directive with its parameter and the body of the directive?

[weibullguy]

I believe this portion of the docstring .. deprecated:: v1.5 is a Sphinx directive which is not really addressed in PEP-257 with regards to how they should be handled. Properly handling these directives would be a welcome enhancement. See also #60.

[akihironitta]

As suggested in Lightning-AI/pytorch-lightning#9422 (comment), one workaround is:

def close():
    """Do any cleanup that is necessary to close an experiment.

    Having this line avoids the formatting.

    .. deprecated:: v1.5
        This method is deprecated in v1.5 and will be removed in v1.7.
        Please use ``something something`` instead.
    """

[weibullguy]

@jjenniferdai with v1.6.2 (and possibly earlier versions), the following remains untouched by docformatter unless passing the --force-wrap argument.

def close(self) -> None:
    """Do any cleanup that is necessary to close an experiment.

    .. deprecated:: v1.5
        This method is deprecated in v1.5 and will be removed in v1.7.
        Please use `LightningLoggerBase.finalize` instead.
    """

I'm closing this since the reported issue is no longer the behavior of docformatter. Handling of Sphinx directives and various docstring syntaxes is still planned.