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.

Sign up for GitHub

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

add documentation to suite types #666

Merged
merged 1 commit into from
Jun 6, 2023
Merged

add documentation to suite types #666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions modules/core/cats/src/weaver/package.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,23 @@ import cats.effect.IO

package object weaver {

type IOSuite = MutableIOSuite
type SimpleIOSuite = SimpleMutableIOSuite
/**
* Extend this when each test in the suite returns an `Resource[IO, Res]` for
* some shared resource `Res`
*/
type IOSuite = MutableIOSuite

/**
* Extend this when each test in the suite returns an `IO[_]`
*/
type SimpleIOSuite = SimpleMutableIOSuite

type GlobalResource = IOGlobalResource
type GlobalRead = GlobalResourceF.Read[IO]
type GlobalWrite = GlobalResourceF.Write[IO]
type FunSuite = FunSuiteIO

/**
* Extend this when each test in the suite is pure and does not return `IO[_]`
*/
type FunSuite = FunSuiteIO
}