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

Improve function signature presentation in HTML #189

Open
awelzel opened this issue May 17, 2023 · 0 comments
Open

Improve function signature presentation in HTML #189

awelzel opened this issue May 17, 2023 · 0 comments

Comments

@awelzel
Copy link
Contributor

awelzel commented May 17, 2023

After looking a bit at docs, I find the HTML Type: presentation of a function's type much too noisy/distracting/challenging for reading. It's also a bit unusual to have the name and prototype separated - may just collapse them. Mentioning function in the signature likely is redundant, too, because this is all in a section called "Functions".

I think with a bit of wrangling we might be able to include the types of parameters into the Parameters section and make them link/clickable there instead (could also allow for some validation that the docstring params align with the signature).

Screenshot-20230517-114821

Comparison examples form other docs

Screenshot-20230517-114305

Screenshot-20230517-114016

Screenshot-20230517-113940

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant