daizutabi / mkapi

A plugin for MkDocs to generate API documentation
https://daizutabi.github.io/mkapi/
MIT License
103 stars 19 forks source link

using colon in docstring - interpreted as return type #17

Closed Ahrak closed 4 years ago

Ahrak commented 4 years ago

Using colons in method/function docstring leads to a problem where mkapi interprets this line as return type of a function:

def show_me_the_problem(self):
"""i show you that this: is a problem"""
    pass

Screenshot: Screenshot from 2020-06-19 07-06-24

daizutabi commented 4 years ago

I fixed this issue in version 1.0.6:

class A:
    def func(self):
        """this: is not type."""

    @property
    def prop(self):
        """this: is type."""
Ahrak commented 4 years ago

resolved. thx :+1: