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

Typehint formatting issues with None #277

Open
gforsyth opened this issue Sep 27, 2023 · 1 comment
Open

Typehint formatting issues with None #277

gforsyth opened this issue Sep 27, 2023 · 1 comment

Comments

@gforsyth
Copy link
Contributor

Hey @machow !

In looking over the Ibis docs, I noticed an inconsistency in the way the Type column of a docstring gets formatted -- https://ibis-project.org/reference/expression-tables.html#ibis.expr.types.relations.Table.aggregate is a good representative example.

When None is in the Type column, it doesn't get formatted as monospace -- you can see under by that it renders as "Sequence[ir.Value] | None", while in the Default column, it's properly monospaced.

Thanks for quartodoc, it's great!

@machow
Copy link
Owner

machow commented Sep 28, 2023

Thanks for flagging -- it looks like the py-shiny team just wraps the whole thing e.g. Sequence[ir.Value] | None in a code element (discussed here: #208). Lemme try wrapping everything in <code> and see if that resolves the issue..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

2 participants