require: invalid examples from doc comments as functions don't return bool · stretchr/testify#1776

(8 comments) (1 reaction) (1 assignee)Go (25,958 stars) (1,704 forks)batch import

bugdocumentationgood first issue

説明

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

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
Issue 種別: documentation
難度: 1
推定時間: under 1 hour
活動状況: blocked
明確さ: clear
前提条件: Go basicstestify require package
初心者向け度: 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.