tweak docs

This commit is contained in:
Jaremy Creechley 2023-09-05 17:18:06 -07:00
parent 4267ddc353
commit 834d0ebd0f
No known key found for this signature in database
GPG Key ID: 4E66FB67B21D3300

View File

@ -54,11 +54,9 @@ proc threadSafeType*[T: ThreadSafeTypes](tp: typedesc[T]) =
proc newThreadResult*[T](
tp: typedesc[T]
): Future[TResult[T]] {.async.} =
## Creates a new TResult including allocating
## a new ThreadSignalPtr.
## Creates a new TResult including getting
## a new ThreadSignalPtr from the pool.
##
## Since allocating the TSP can fail, this returns
## a Result.
mixin threadSafeType
when not compiles(threadSafeType):
{.error: "only thread safe types can be used".}