Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

System fails if type hints are present #25

Open
Paethon opened this issue Jul 7, 2020 · 3 comments
Open

System fails if type hints are present #25

Paethon opened this issue Jul 7, 2020 · 3 comments

Comments

@Paethon
Copy link

Paethon commented Jul 7, 2020

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
@jramapuram
Copy link

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

@jakob1379
Copy link

jakob1379 commented Nov 19, 2021

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

@chraibi
Copy link

chraibi commented Sep 23, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants