Skip to content

Inconsistent description on AssertionScope methods #1605

@eNeRGy164

Description

@eNeRGy164

Description

Although the methods share name and signature, the XML Documentation on AssertionScope, ContinuedAssertionScope and GivenSelector<T> is vastly different.
As a consumer of FA I would expect the text to be consistent.

Complete minimal example reproducing the issue

Look at the documentation of every ForCondition or FailWith in the following example:
(for example, hover over them in Visual Studio)

Execute.Assertion
    .ForCondition(true)
    .FailWith("First assertion")
    .Then
    .ForCondition(true)
    .FailWith("Second assertion")
    .Then
    .Given(() => true)
    .ForCondition(subject => true)
    .FailWith("Third assertion");

Expected behavior:

Consistent documentation.
Some differences might be valid, but in general the text should be the same.

Actual behavior:

Every method has a different text

ForCondition

  1. image
  2. image
  3. image

FailWith

  1. image
  2. image
  3. image

I will create a PR to improve this.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions