Search code examples
pythonpython-2.7docstring

Return type for __init__ in docstrings


I've recently started using PyCharm and it support type hinting for Python 2.x using docstrings which I'd like to start using. What should be the :return: value for the __init__ method of a class Foo? I can't find an answer to wether it should be Foo, None, nothing, or remove the attribute that PyCharm is creating in the docstring template for me?


Solution

  • (The answer to the question credit should go to @ppperry)

    Because all __init__ methods return None, no docstrings about return type are required.