-
Notifications
You must be signed in to change notification settings - Fork 47
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
Add documentation on kind signatures, which ones are displayed, and why #437
Add documentation on kind signatures, which ones are displayed, and why #437
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've included a few comments. In general this feels a little long; I wonder if we could trim some of the details or move them into the purs docs
documentation instead.
I'm also not totally sold on the 'interesting' vs. 'uninteresting' terminology, though I don't have a better pairing in mind at the moment.
I've addressed all feedback. I tried making it shorter by removing a few things. How is it now? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example sections feel redundant with the “Interesting kinds are displayed; Uninteresting kinds are not” section. 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? |
Yes, but I don’t think it is necessary to rehash what uninteresting kinds are in the “Examples of "uninteresting" kind signatures“ section. |
How are the latest changes? |
@thomashoneyman Thanks for the approval! This has been merged. We can redeploy Pursuit and finally announce v0.14.3 |
Fixes #434
I'll have to update the changelog with an entry for this after #436 gets merged.