docstrings

My problem

I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented __init__ methods.

My solution idea

It would be great to have the ability to have a flag (for example --ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the __init__ the flag could be ``--ignore-fu

With Python 3.5.x having reached its end of life/support, we can begin to use "advanced" features from Python 3.6:

• f-strings
• variable annotations over

A common-ish mistake for docstring author is to use the label of a parameter as opposed to the actual name. The error message in this scenario could be improved. Right now the parameter docstring is reported as missing. It could be something like "Parameter label (X) is used instead of name (Y)".

I was using mkdocstrings, but I think this issue is specifically related to pytkdocs.

Is your feature request related to a problem? Please describe.

Yes. I had a docstring of a generator that I was using mkdocstrings (v0.14.0) to compile the documentation for, something like:

    """
    Get the next number in the sequence

    Args:
        n (int): The upper limit of the r

The constructor should be documented at class level and not at the init function.