avajs/ava

First parameter for "snapshot" assertion should be called "value" for consistency

Offen

#2.931 geöffnet am 05.01.2022

 (9 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (1.408 Forks)batch import
help wanted

Repository-Metriken

Stars
 (20.600 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Currently, it is called "expected": https://github.com/avajs/ava/blob/main/docs/03-assertions.md#snapshotexpected-message

However, that is inconsistent with other assertion APIs like "is" where parameters are named "value" and "expected": https://github.com/avajs/ava/blob/main/docs/03-assertions.md#isvalue-expected-message

In the case of "snapshot", the expected data is represented by the previously-captured snapshot and the test data (often called "actual") is what gets passed to the function via the first parameter.

Contributor Guide