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

Describe example questions at top of nomenclature page. #3460

Closed
arosien opened this issue Jun 8, 2020 · 4 comments · Fixed by #3469
Closed

Describe example questions at top of nomenclature page. #3460

arosien opened this issue Jun 8, 2020 · 4 comments · Fixed by #3469

Comments

@arosien
Copy link

arosien commented Jun 8, 2020

Comment from reader:

Should these three questions be on the nomenclature page? They look like they’re supposed to be on FAQ. There is no answer and they just kind of float there:

What is the difference between unit and void?
To discard the first value and keep only the first effect, is it <* or *>?
How do I make a computation F[A] fail by checking a condition on the value?

https://typelevel.org/cats/nomenclature.html

This page could preface those questions the paragraph that currently follows them:

This is a catalogue of the major functions, type classes, and data types in Cats. It serves as a bird’s-eye view of each class capabilities. It is also intended as a go-to reference for Cats users, who may not recall the answer to questions like these:

☝️ suggested copy

@rmehri01
Copy link
Contributor

Hi, I'd like to help with this! Just to clarify, do you mean these questions should be moved to FAQ or just moved below the paragraph you suggested?

@arosien
Copy link
Author

arosien commented Jun 12, 2020

I meant the latter, move the questions below the suggested paragraph. (And make the questions a regular font size, not the giant size it is now)

@arosien
Copy link
Author

arosien commented Jun 12, 2020

And thanks for your help!

@rmehri01
Copy link
Contributor

Ah okay, no problem :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants