Skip to content

Commit

Permalink
Cosmetic
Browse files Browse the repository at this point in the history
  • Loading branch information
scordio committed Aug 27, 2024
1 parent 8db579c commit 76cb47b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@ void test(@TempDir(factory = JimfsTempDirFactory.class) Path tempDir) {
`tempDir` is resolved into an in-memory temporary directory based on Jimfs, appropriately configured for the current
operating system.

Note that only annotated fields or parameters of type `Path` are supported as Jimfs is a non-default file system,
and `File` instances are associated with the default file system only.

### @JimfsTempDir

`@JimfsTempDir`, a `@TempDir`
Expand Down Expand Up @@ -121,6 +118,11 @@ junit.jupiter.tempdir.factory.default=io.github.scordio.jimfs.junit.jupiter.Jimf
The factory will be used for all `@TempDir` annotations unless the `factory` attribute of the annotation
specifies a different type.

### Limitations

Jimfs JUnit Jupiter only supports annotated fields or parameters of type `Path`, as Jimfs is a non-default file
system and `File` instances can only be associated with the default file system.

## Improvements

Compared to the configuration options that Jimfs provides, Jimfs JUnit Jupiter exposes a much smaller surface to keep
Expand Down

0 comments on commit 76cb47b

Please sign in to comment.