stretchr/testify

require: invalid examples from doc comments as functions don't return bool

Open

#1,776 建立於 2025年8月4日

在 GitHub 查看
 (8 留言) (1 反應) (1 負責人)Go (25,958 star) (1,704 fork)batch import
bugdocumentationgood first issue

描述

Description

The doc comments for multiple functions in the require package have code examples that are invalid. Example:

https://github.com/stretchr/testify/blob/a53be35c3b0cfcd5189cffcfd75df60ea581104c/require/require.go#L1391

The example reads:

	  if require.NoError(t, err) {
		   require.Equal(t, expectedObj, actualObj)
	  }

but the NoError() function does not return any value, so this is invalid.

There are similar invalid examples in the doc comments for NoErrorf, NotEmpty and NotEmptyf.

貢獻者指南

技術棧
go
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Go basicstestify require package
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Examine the doc comments for NoError, NoErrorf, NotEmpty, NotEmptyf in require/require.go (lines around 1391). The examples incorrectly use the functions in if statements. The fix should either remove the if or change the example to demonstrate proper usage without relying on a return value. Check existing tests or documentation style for consistency.