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

No documentation rendered for return type when function has no arguments #1386

Open
lukastk opened this issue Nov 18, 2023 · 0 comments
Open
Labels
bug Something isn't working

Comments

@lukastk
Copy link
Contributor

lukastk commented Nov 18, 2023

No documentation is rendered for the return type, if the function has no arguments. Compare the two functions defined below:

#|export
def foo1(
        ) -> int: # Return type documentation
    """Docstring"""
    return 1

#|export
def foo2(
        a, # test
        ) -> int: # Return type documentation
    """Docstring"""
    return 1

The following documentation is rendered, after running nbdev_docs:

image

You can see that the return type is missing documentation in foo1.

You can find the reproduced bug in this repository:

https://github.com/lukastk/nbdev_method_doc_test

@lukastk lukastk added the bug Something isn't working label Nov 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant