pydocstringformatter icon indicating copy to clipboard operation
pydocstringformatter copied to clipboard

Support docstrings that only have type declarations

Open DanielNoord opened this issue 2 years ago • 1 comments

class A:
    attribute = 1
    """
    :type: Optional[int]
    """

This shouldn't get a period at the end of the line and probably also shouldn't be moved onto one single line.

DanielNoord avatar Jul 06 '22 10:07 DanielNoord

We should also decide what to do in this case:

class AstroidExample:
    def __init__(
        self,
        lineno=None,
    ):
        """
        :param lineno: The line that this node appears on in the source code
        :type lineno: int or None
        """

(i.e. not treat the first line as if it was a summary ?)

Pierre-Sassoulas avatar Sep 18 '22 13:09 Pierre-Sassoulas