stretchr/testify

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

Open

#1.776 geöffnet am 4. Aug. 2025

Auf GitHub ansehen
 (8 Kommentare) (1 Reaktion) (1 zugewiesene Person)Go (1.704 Forks)batch import
bugdocumentationgood first issue

Repository-Metriken

Stars
 (25.958 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 15h) (2 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Korrigieren Sie die Dokumentationsbeispiele für require.NoError, NoErrorf, NotEmpty, NotEmptyf, indem Sie die if Anweisung entfernen und die korrekte Verwendung zeigen.
Tech Stack
go
Domain
testing
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Go
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90