stretchr/testify

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

Open

#1776 opened on Aug 4, 2025

View on GitHub
 (8 comments) (1 reaction) (1 assignee)Go (25,958 stars) (1,704 forks)batch import
bugdocumentationgood first issue

Description

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.

Contributor guide

Tech stack
go
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go basicstestify require package
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.