avajs/ava

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

Open

#2,931 建立於 2022年1月5日

在 GitHub 查看
 (9 留言) (1 反應) (0 負責人)JavaScript (20,600 star) (1,408 fork)batch import
help wanted

描述

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.

貢獻者指南

技術棧
javascriptnodejs
領域
testing
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaScript basicsAVA testing framework basicsGit and GitHub workflow
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
The issue requests renaming the first parameter of the 'snapshot' assertion from 'expected' to 'value' for consistency with other assertions like 'is'. This involves updating the documentation in 'docs/03 assertions.md' and potentially the source code where the snapshot assertion is defined. Check for any related tests that reference the parameter name. The change is localized and does not affect functionality.