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

Improve description of InvariantOps #2860

Merged
merged 1 commit into from
Mar 29, 2022

Conversation

bplommer
Copy link
Contributor

No description provided.

@diesalbla
Copy link
Contributor

diesalbla commented Mar 28, 2022

Thanks for the Pull Request. The new explanation is clearer and more explicit.

One doubt, though, is whether an implicit class, which is just a way to go around the limitations of the Scala language, is something one should document in the Scaladocs. It does not represent an entity on the data model, or a utility to perform some operations. It is just a conduit to get some operations defined on the stream. Would perhaps a mere code comment (single star) suffice?

Copy link
Contributor

@diesalbla diesalbla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving since, as it is, is improvement.

@mpilquist mpilquist merged commit 5f69848 into typelevel:main Mar 29, 2022
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