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

Group constraints classes and type aliases together #265

Open
Iltotore opened this issue Sep 11, 2024 · 0 comments
Open

Group constraints classes and type aliases together #265

Iltotore opened this issue Sep 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Iltotore
Copy link
Owner

To better organize the API documentation, especially for io.github.iltotore.iron.constraint.xxx objects, constraints should be grouped together, no matter if they're defined using a type alias (e.g Positive) or a final class (e.g Greater).

-- Constraints
final class Greater
type GreaterEqual
type Positive
...

instead of

-- Classes
final class Greater
...

-- Types
GreaterEqual
Positive
...

This can be done using @group, @groupname and @groupprio. See Ciris' ConfigValue for example.

@Iltotore Iltotore added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant