Skip to content

Commit ce4c923

Browse files
committed
docs: update readme with some notes about the version
1 parent 422ddfc commit ce4c923

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
Common tools for writing tests using XUnit, AutoFixture, NSubstitute and FluentAssertions.
66

7+
> **Version Notes:**
8+
> If you are using the `MemberAutoNSubstituteData` attribute, ensure that both `xunit` and `xunit.extensibility.core` packages are set to version **2.9.0**.
9+
> This is because the latest versions of xUnit are currently incompatible with `MemberAutoNSubstituteData` due to an unresolved issue. Although [xunit/xunit#3031](https://github.com/xunit/xunit/issues/3031) has been closed, the problem remains unresolved.
10+
> Upgrading beyond version 2.9.0 may result in test failures or unexpected behavior.
11+
12+
713
## Test Attributes
814

915
| Name | Description |
@@ -12,7 +18,8 @@ Common tools for writing tests using XUnit, AutoFixture, NSubstitute and FluentA
1218
| `InlineAutoNSubstituteData` | Provides a data source for a data theory, with the data coming from inline values combined with auto-generated data specimens generated by AutoFixture and NSubstitute.|
1319
| `MemberAutoNSubstituteData` | Provides a data source for a data theory, with the data coming from one of the following sources and combined with auto-generated data specimens generated by AutoFixture and NSubstitute.|
1420

15-
Note: NSubstitute is used when the type being created is abstract, or when the `[Substitute]` is applied.
21+
> **Note:**
22+
> NSubstitute is used when the type being created is abstract, or when the `[Substitute]` is applied.
1623
1724
## Test Helpers
1825

0 commit comments

Comments
 (0)