golang/go

math/big: doesn't have example in the documentation for each function

Open

#59.321 aperta il 29 mar 2023

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)Go (19.008 fork)batch import
DocumentationNeedsInvestigationhelp wanted

Metriche repository

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

Descrizione

This makes the package a bit hard to use and I'm not sure I properly use it. For example, NewRat return a *Rat, I have no idea if I should or not check for a nil value? Adding examples should clarify a lot of questons.

Guida contributor

Direzione di ricerca
Identifica le funzioni nel pacchetto math/big che mancano di esempi. Guarda gli esempi esistenti nella libreria standard di Go per capire come scrivere esempi testabili. Per ogni funzione, scrivi un esempio eseguibile che dimostri l'uso tipico.
Tech stack
go
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
GoGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85