search

purescript / pursuit

Website for hosting and searching PureScript API documentation
https://pursuit.purescript.org/
Other
169 stars 47 forks source link

Operator aliases should have a link to their function #370

Open rndnoise opened 6 years ago

rndnoise commented 6 years ago

It seems like the text "Operator alias for Control.Bind.composeKleisli" could be made as a link to the thing it refers to, and/or the operator could include the type signature. Same idea for type operators.

Examples:

hdgarrood commented 6 years ago

I'd like to take a step back and reconsider the design of operator aliases a little more. For instance, I think for the cases where an operator alias is defined in the same module as the declaration it aliases (which is the case 99% of the time, it seems), it would be nice to indicate that the declaration has an operator alias on the original (named) declaration. We might also consider not having a separate declaration listed for the operator alias at all? Of course we also need to make sure the case where an alias is declared in a different module is also handled sensibly.

@grossbart, do you have any thoughts?

The only reason I didn't do this in the first place was just that it was extra effort.