We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug When you set a conditional value for the function argument, the default value shown in the doc is weirdly formatted!
Versions (please complete the following information):
Issue:
def greeting(name: str = "John" if is_administrator else "Jamy") -> None: ...
After numpy doc generation:
def greeting(name: str = "John" if is_administrator else "Jamy") -> None: """_summary_ Args: name (str, optional): _description_. Defaults to "John"ifis_administratorelse"Jamy". """ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ...
Apparently, the rest of the string after the = symbol is considered as the default value for the parameter which is not true in some cases.
=
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Describe the bug
When you set a conditional value for the function argument, the default value shown in the doc is weirdly formatted!
Versions (please complete the following information):
Issue:
After numpy doc generation:
Apparently, the rest of the string after the
=
symbol is considered as the default value for the parameter which is not true in some cases.The text was updated successfully, but these errors were encountered: