format.vader

# vim:set et sw=4 ts=4 tw=79:

Execute (Setup template formatter):
    Save g:pydocstring_formatter
    let g:pydocstring_formatter = 'sphinx'

# Format all
#-------------------------------------------------------------------------------
Given python (Format all):
    class Foo:
        def foo(arg1):
            pass


        def bar(arg1, arg2):
            pass


Execute:
    :PydocstringFormat
    :sleep 1

Expect python:
    class Foo:
        """Foo."""

        def foo(arg1):
            """foo.

            :param arg1:
            """
            pass


        def bar(arg1, arg2):
            """bar.

            :param arg1:
            :param arg2:
            """
            pass


Given python (Format all twice):
    class Foo:
        def foo(arg1):
            pass


        def bar(arg1, arg2):
            pass


Execute:
    :PydocstringFormat
    :sleep 1
    :PydocstringFormat
    :sleep 1

Expect python:
    class Foo:
        """Foo."""

        def foo(arg1):
            """foo.

            :param arg1:
            """
            pass


        def bar(arg1, arg2):
            """bar.

            :param arg1:
            :param arg2:
            """
            pass

Given python (Ignore __init__):
    class Foo:
        def __init__(self, arg1):
            pass

        def foo(arg1):
            pass

        def bar(arg1, arg2):
            pass


Execute:
    :let g:pydocstring_ignore_init = 1
    :PydocstringFormat
    :sleep 1

Expect python:
    class Foo:
        """Foo."""

        def __init__(self, arg1):
            pass

        def foo(arg1):
            """foo.

            :param arg1:
            """
            pass

        def bar(arg1, arg2):
            """bar.

            :param arg1:
            :param arg2:
            """
            pass