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

keyword only '*' does not work with documentation #1369

Open
CyprienRicque opened this issue Sep 21, 2023 · 0 comments
Open

keyword only '*' does not work with documentation #1369

CyprienRicque opened this issue Sep 21, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@CyprienRicque
Copy link

CyprienRicque commented Sep 21, 2023

Example

Hello! Using keyword only argument such as:

#| export

def super_func(
        keyword_or_non_keyword_arg, # this is a keyword or non-keyword arg
        *, 
        keyword_only_arg # this is a keyword only arg 
) -> str: # return string
    "super func"
    ... 

makes the documentation not working:

show_doc(super_func)
super_func
 super_func (keyword_or_non_keyword_arg, keyword_only_arg)
super func
| | Type | Details | | – | ——– | ———– | | keyword_or_non_keyword_arg | | this is a keyword or non-keyword arg | | keyword_only_arg | | | | Returns | str | return string |

the documentation for keyword_only_arg is absent
image

Configuration

Python 3.7.16
nbdev 2.3.12

@CyprienRicque CyprienRicque added the bug Something isn't working label Sep 21, 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