Skip to content

Add documentation about built-in equalization profiles #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TonyTroeff merged 1 commit into from
Aug 5, 2025
Merged

Add documentation about built-in equalization profiles #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ equalizer.AssertEquality(expectedValue, actualValue);
equalizer.AssertInequality(expectedValue, actualValue);
```

### Built-in equalization profiles

There are a few equalization profiles that are registered by default for any `Equalizer` instance:
- Specialized equalization profiles that evaluate [value templates](#value-templates);
- Equalization profiles designed to compare common data structures (`IDictionary` and `IEnumerable` instances);
- The standard equalization profile which determines equality using default comparison mechanisms, including the `object.Equals` method.

### Registering additional equalization profiles

The registration of additional equalization profiles can happen in three different ways:
Expand Down