Add documentation on kind signatures, which ones are displayed, and why

purescript / pursuit

Website for hosting and searching PureScript API documentation

https://pursuit.purescript.org/

Other

170 stars 47 forks source link

Closed JordanMartinez closed 3 years ago

JordanMartinez commented 3 years ago

Fixes #434

I'll have to update the changelog with an entry for this after #436 gets merged.

JordanMartinez commented 3 years ago

I've addressed all feedback. I tried making it shorter by removing a few things. How is it now?

JordanMartinez commented 3 years ago

Perhaps we could provide examples when explaining what kinds are uninteresting and then show some interesting kinds as counterexamples?

Isn't that what I already do in this PR in the subsections?

kl0tl commented 3 years ago

Yes, but I don’t think it is necessary to rehash what uninteresting kinds are in the “Examples of "uninteresting" kind signatures“ section.

JordanMartinez commented 3 years ago

How are the latest changes?

JordanMartinez commented 3 years ago

@thomashoneyman Thanks for the approval! This has been merged. We can redeploy Pursuit and finally announce v0.14.3