Autofix for undocumented-public-function: insert docstring stub

[sbrugman]

The undocumented-public-function rule currently has no autofix.
Writing documentation for functions can be made more effective by providing the documentation template automatically.
PyCharm allows to insert a "documentation string stub":

def func1(arg1: str, arg2: int) -> int:
    raise ValueError("Value not valid")

Proposed by PyCharm (depends on the docstring style configuration):

def func1(arg1: str, arg2: int) -> int:
    """

    Args:
        arg1: 
        arg2: 

    Returns:
        object: 
    """
    raise ValueError("Value not valid")

Would you accept a similar (unsafe) fix in ruff?

Ideally, the rule considers arguments, return values and exceptions.

def func1(arg1: str, arg2: int) -> int:
    """...

    Args:
        arg1: ...
        arg2: ...

    Returns:
        ... 

    Raises:
        ValueError: ...
    """
    raise ValueError("Value not valid")

[MichaReiser]

This could make sense, but only with Applicabilty::DisplayOnly so that the fix needs to be applied manually because this is more an editor refactor than a "proper fix".

I'm not sure how the CLI or LSP handle display only fixes

[sbrugman]

For completeness:

Applying the fix will break down undocumented-public-function (D103) into multiple violations:

• empty-docstring-section (D414): Section has no content ("Returns")
• undocumented-param (D417): Missing argument descriptions in the docstring for func1
• and various others related to the function summary/description D415, D212, D205