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

[data] Flat scaladoc improvement #1127

Merged
merged 2 commits into from
Apr 4, 2025
Merged

[data] Flat scaladoc improvement #1127

merged 2 commits into from
Apr 4, 2025

Conversation

fwbrasil
Copy link
Collaborator

@fwbrasil fwbrasil commented Apr 4, 2025

I noticed the missing scaladoc today and it's an important piece of Kyo's design

@@ -2,12 +2,43 @@ package kyo

import scala.quoted.*

/** A compile-time guarantee that a parametrized opaque type with internal flat encoding doesn't contain instances of itself.
*
* When designing opaque types with flat internal encodings like `A | Container[A]` (union types), runtime discrimination between the cases
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think a one liner on why you do this is helpful. But otherwise LGTM.

@fwbrasil fwbrasil merged commit 102bdbf into main Apr 4, 2025
3 checks passed
@fwbrasil fwbrasil deleted the flat-scaladoc branch April 4, 2025 07:34
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.

2 participants