stretchr/testify

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

Open

#1,776 opened on Aug 4, 2025

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

Repository metrics

Stars
 (25,958 stars)
PR merge metrics
 (Avg merge 6d 15h) (2 merged PRs in 30d)

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

Research direction
Correct the doc examples for require.NoError, NoErrorf, NotEmpty, NotEmptyf to remove the if statement and show proper usage.
Tech stack
go
Domain
testing
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90