sphinx-doc.el icon indicating copy to clipboard operation
sphinx-doc.el copied to clipboard

System fails if type hints are present

Open Paethon opened this issue 4 years ago • 3 comments

As the title says: If type hints are used, sphinx-doc does not work anymore

E.g

def sum(a:int, b:int):
    return a+b

Paethon avatar Jul 07 '20 19:07 Paethon

Would be great to get this in as typing in python is immensely helpful.

jramapuram avatar Nov 18 '20 16:11 jramapuram

I would suggest something like

def sum(a:int, b:int) -> int:
    """TODO describe function

    :param a (:type int): 
    :param a (:type int) 
    :returns int: 

    """

The return type could be set automatically! :D

jakob1379 avatar Nov 19 '21 13:11 jakob1379

This is not yet fixed I assume. Just run into this issue today.

chraibi avatar Sep 23 '22 12:09 chraibi