📝 docs: Add pre-defined constraints in documentation #225
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Iltotore
requested changes
Feb 25, 2024
docs/_docs/reference/constraint.md
Outdated
| @@ -188,3 +188,104 @@ trait RefinedTypeOps[A, C, T]: | |||
| def option(value: A): Option[T] = | |||
| Option.when(rtc.test(value))(value.asInstanceOf[T]) | |||
| ``` | |||
|
|
|||
| # Pre-defined constraints | |||
There was a problem hiding this comment.
This section (and children) should have an extra # as a h1 (single #) is used for the title.
There was a problem hiding this comment.
Fixed in the next commit
docs/_docs/reference/constraint.md
Outdated
| ## Global constraints | ||
|
|
||
| Some constraints are available for all types. | ||
| They are located in the `io.github.iltotore.iron.constraint.any` object. |
There was a problem hiding this comment.
What about using [[package.name]] instead of backquotes to link it to the Scaladoc?
There was a problem hiding this comment.
You're right, i'm fixing this
It's helpful, but I thought having all the constants in a single document may be clearer for some persons (including me 😃) |
Iltotore
approved these changes
Feb 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I always struggled to remember pre-defined constraints, I added them to the mini-site.