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

Show signatures in index page #1485

Open
ffaf1 opened this issue May 16, 2022 · 1 comment
Open

Show signatures in index page #1485

ffaf1 opened this issue May 16, 2022 · 1 comment

Comments

@ffaf1
Copy link

ffaf1 commented May 16, 2022

See as an example this index page on hackage. Having:

attrib :: LString -> (String, LString)

would be better than current layout (plain attrib, no sig, just module link).

see also: people disagreeing with me.

@Kleidukos Kleidukos self-assigned this May 16, 2022
@Kleidukos
Copy link
Member

@ffaf1 The package documentation you show as an example happens to be generated with an older version of the Haddock theme. Let's consider a more recently-updated package instead: https://hackage.haskell.org/package/servant-openapi3-2.0.1.5/docs/doc-index.html

Screenshot 2022-05-17 at 09-44-20 servant-openapi3-2 0 1 5 Generate a Swagger_OpenAPI_OAS 3 0 specification for your servant API  (Index)

In this example, we can see that the space if fairly constrained, so the type signatures cannot easily be displayed by default.

If we want to go through with this, we'd have to display the type signatures with a tooltip.

@Kleidukos Kleidukos removed their assignment Mar 10, 2023
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

2 participants