stretchr/testify

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

Open

#1776 aperta il 4 ago 2025

Vedi su GitHub
 (8 commenti) (1 reazione) (1 assegnatario)Go (1704 fork)batch import
bugdocumentationgood first issue

Metriche repository

Star
 (25.958 star)
Metriche merge PR
 (Merge medio 6g 15h) (2 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Correggi gli esempi di documentazione per require.NoError, NoErrorf, NotEmpty, NotEmptyf rimuovendo l'istruzione if e mostrando l'uso corretto.
Tech stack
go
Dominio
testing
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90