golang/go

testing: document -test.benchmem and ReportAllocs output format

Open

#42.239 aperta il 28 ott 2020

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)Go (19.008 fork)batch import
DocumentationNeedsFixhelp wanted

Metriche repository

Star
 (133.883 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Filing this bug on behalf of someone who prefers not to do it directly:

The ⁠(*testing.B).ReportAllocs function's documentation says that its output is the same as setting -test.benchmem. However, there is as far as I can tell no explanation anywhere of what, exactly, -test.benchmem is or what it does. There is also no explanation as to what the output format is. For instance, in an output line like

BenchmarkF-34         	    9718	    672043 ns/op	   34474 B/op	     508 allocs/op

I can see the lines with four numbers, but one of them is completely dimensionless and the others aren't entirely clear.

Guida contributor

Direzione di ricerca
Esamina la documentazione del pacchetto testing per test.benchmem e ReportAllocs. Guarda il codice sorgente per la formattazione dell'output. Considera l'aggiunta di una spiegazione dei campi di output del benchmark alla documentazione del pacchetto.
Tech stack
go
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
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.
85