From a37c8cff95eb2e3d4a1739500bdeb74da9c9ba7c Mon Sep 17 00:00:00 2001 From: Stefano Cordio Date: Tue, 27 Aug 2024 02:30:05 +0200 Subject: [PATCH] Cosmetic Signed-off-by: Stefano Cordio --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a1d341b..7d1c69a 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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 be associated with the default file system only. + ## Improvements Compared to the configuration options that Jimfs provides, Jimfs JUnit Jupiter exposes a much smaller surface to keep