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.