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

Strictly following numpydoc specification for parameters causes extra paranthesis in output #340

Open
catanzaromj opened this issue Apr 15, 2024 · 0 comments
Labels
api:renderer type:bug Something isn't working

Comments

@catanzaromj
Copy link

catanzaromj commented Apr 15, 2024

Hi! Thanks for the awesome package.

The Numpydoc specification for Parameters uses a space on both sides of the colon between the variable name and type, as in

Parameters
----------
x : int

When I follow Numpydoc and include a space on each side of the colon in docstrings, I get extra parentheses in the quartodoc output:
image

The Numpydocs make it seem that a docstring like

Parameters
----------
x: int

is wrong (eventhough I prefer it). But in this case, the extraneous parentheses do not appear in the quartodoc output:
image

Is this a feature or a bug?

@machow machow added this to quartodoc Aug 20, 2024
@machow machow added api:renderer type:bug Something isn't working labels Aug 20, 2024
@machow machow moved this to Todo in quartodoc Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api:renderer type:bug Something isn't working
Projects
Status: Todo
Development

No branches or pull requests

2 participants