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

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

Merged
merged 12 commits into from
Jul 12, 2021
Merged

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

merged 12 commits into from
Jul 12, 2021

Conversation

JordanMartinez
Copy link
Contributor

@JordanMartinez JordanMartinez commented Jul 7, 2021

Fixes #434

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

Copy link
Member

@thomashoneyman thomashoneyman left a 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.

static/help-docs/users.md Outdated Show resolved Hide resolved
static/help-docs/users.md Outdated Show resolved Hide resolved
static/help-docs/users.md Outdated Show resolved Hide resolved
static/help-docs/users.md Outdated Show resolved Hide resolved
@JordanMartinez
Copy link
Contributor Author

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

Copy link
Member

@kl0tl kl0tl left a 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?

static/help-docs/users.md Outdated Show resolved Hide resolved
static/help-docs/users.md Outdated Show resolved Hide resolved
@JordanMartinez
Copy link
Contributor Author

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
Copy link
Member

kl0tl commented Jul 9, 2021

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

@JordanMartinez
Copy link
Contributor Author

How are the latest changes?

@JordanMartinez JordanMartinez merged commit 0238ca8 into purescript:master Jul 12, 2021
@JordanMartinez JordanMartinez deleted the addKindDocPage branch July 12, 2021 13:02
@JordanMartinez
Copy link
Contributor Author

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

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

Successfully merging this pull request may close these issues.

Add an explanation on kind signatures appearing in documentation
3 participants