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

Minor fixes in Pull docs #2500

Merged
merged 6 commits into from
Jul 22, 2021
Merged

Minor fixes in Pull docs #2500

merged 6 commits into from
Jul 22, 2021

Conversation

valencik
Copy link
Member

This PR fixes a handful of things in the Pull docs.

In this I noticed that only as has the @tparam and @param annotations, I could add these to the other methods like map and flatMap if that's desired. I'm not sure what the best practice is here.

The docs for fs2 are really great and helpful, thank you so much!

@SystemFw SystemFw merged commit f90ea36 into typelevel:main Jul 22, 2021
@mpilquist
Copy link
Member

Re: @param and @tparam, I don't have strong opinions besides one -- that we don't put a policy in place that results in lots of low quality documentation boilerplate. E.g., if we say "every method should have @param docs for every parameter" and then start writing docs like "@param f The function to apply", we're doing it wrong :)

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.

3 participants