Add documentation #643
Open
Add documentation #643
Conversation
This file contains hidden or 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
danicheg
reviewed
Jan 24, 2026
|
|
||
| /** | ||
| * Set how long an idle resource is allowed to remain in the pool before it becomes eligible for | ||
| * eviction. If not configured, the builder defaults to 30 seconds. |
Member
There was a problem hiding this comment.
Concrete references to default values could easily be forgotten to be updated when the actual values change. Wouldn't it be better if we provided a link to the values in the code?
Author
There was a problem hiding this comment.
Oh, you mean something like [[DefaultSetting.idleTimeAllowedInPool 30 seconds]] – correct?
|
|
||
| /** | ||
| * Set the interval between eviction runs of the pool reaper. If not configured, the builder | ||
| * defaults to 5 seconds. |
|
|
||
| /** | ||
| * Set the maximum number of idle resources allowed per key. If not configured, the builder | ||
| * defaults to 100. |
|
|
||
| /** | ||
| * Set the maximum number of idle resources allowed across all keys. If not configured, the | ||
| * builder defaults to 100. |
|
|
||
| /** | ||
| * Set the maximum total number of concurrent resources permitted by the pool. If not | ||
| * configured, the builder defaults to 100. |
|
|
||
| /** | ||
| * Set how long an idle resource is allowed to remain in the pool before it becomes eligible for | ||
| * eviction. If not configured, the builder defaults to 30 seconds. |
|
|
||
| /** | ||
| * Set the interval between eviction runs of the pool reaper. If not configured, the builder | ||
| * defaults to 5 seconds. |
|
|
||
| /** | ||
| * Set the maximum number of idle resources allowed across the pool. If not configured, the | ||
| * builder defaults to 100. |
|
|
||
| /** | ||
| * Set the maximum total number of concurrent resources permitted by the pool. If not | ||
| * configured, the builder defaults to 100. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I recently came across this library and found it really helpful, but it currently has very little documentation. So it is quite difficult to get started with. I took the liberty of writing the missing docs – both Scaladoc in the code and Laika pages for the microsite.
For transparency: I did use AI to help draft or refine some of the text, but I carefully reviewed every generated piece. If any factual inaccuracies slipped in, they are far more likely due to my own misunderstanding than to AI hallucination.
All the code examples are handwritten 😅