avajs/ava

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

Aperta

#2931 aperta il 5 gen 2022

Vedi su GitHubGuida contributor
 (9 commenti) (1 reazione) (0 assegnatari)JavaScript (1408 fork)batch import
help wanted

Metriche repository

Star
 (20.600 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
La richiesta del problema è di rinominare il primo parametro dell'asserzione 'snapshot' da 'expected' a 'value' per coerenza con altre asserzioni come 'is'. Ciò comporta l'aggiornamento della documentazione in 'docs/03 assertions.md' e potenzialmente il codice sorgente in cui è definita l'asserzione snapshot. Verificare la presenza di test correlati che fanno riferimento al nome del parametro. La modifica è localizzata e non influisce sulla funzionalità.
Tech stack
javascriptnodejs
Dominio
testing
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScriptGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80