Add documentation about necessity of the caller argument expression

fluentassertions · Dec 30, 2022 · 3b134c9 · 3b134c9
1 parent 97ccf12
commit 3b134c9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/Src/FluentAssertions/Primitives/BooleanAssertions.cs b/Src/FluentAssertions/Primitives/BooleanAssertions.cs
@@ -123,6 +123,7 @@ public AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", pa
     /// Asserts that the value implies the specified <paramref name="consequent"/> value.
     /// </summary>
     /// <param name="consequent">The right hand side for the implication</param>
+    /// <remarks>If you want to use the `because` / `becauseArgs` construct, it is **necessary** to use the caller argument expression, because this would lead to unexpected failure messages, when omitted!</remarks>
     /// <param name="because">
     /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
     /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.

diff --git a/docs/_pages/booleans.md b/docs/_pages/booleans.md
@@ -35,3 +35,5 @@ Passing a custom caller argument expression is beneficial for this assertion to
 bool anotherBoolean = true;
 theBoolean.Should().Imply(anotherBoolean, nameof(anotherBoolean));
 ```
+
+If you want to use the `because` / `becauseArgs` construct, it is **necessary** to use the caller argument expression, because this would lead to unexpected failure messages, when omitted!