Skip to content

Commit ce4325a

Browse files
committed
added a bit of docs
1 parent b44494d commit ce4325a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

std/shared/src/main/scala/cats/effect/std/SecureRandom.scala

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,9 @@ object SecureRandom extends SecureRandomCompanionPlatform {
124124
}
125125

126126
/**
127+
* Builds a `SecureRandom[F]` value for effect types that are [[cats.effect.kernel.Sync]] and initializes random
128+
* state using the same effect type
129+
*
127130
* On the JVM, delegates to [[java.security.SecureRandom]].
128131
*
129132
* In browsers, delegates to the
@@ -139,6 +142,10 @@ object SecureRandom extends SecureRandomCompanionPlatform {
139142
override def javaSecuritySecureRandom[F[_]: Sync]: F[SecureRandom[F]] =
140143
javaSecuritySecureRandomGeneric
141144

145+
/**
146+
* Builds a `SecureRandom[G]` value for effect types that are [[cats.effect.kernel.Sync]] but initializes random
147+
* state using another effect constructor
148+
*/
142149
override def javaSecuritySecureRandomGeneric[F[_]: Sync, G[_]: Sync]: F[SecureRandom[G]] =
143150
super.javaSecuritySecureRandomGeneric[F, G]
144151

0 commit comments

Comments
 (0)