golang/go

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

Open

#59 321 ouverte le 29 mars 2023

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)Go (19 008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Métriques du dépôt

Stars
 (133 883 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Identifiez les fonctions du package math/big qui manquent d'exemples. Regardez les exemples existants dans la bibliothèque standard de Go pour savoir comment écrire des exemples testables. Pour chaque fonction, écrivez un exemple exécutable qui démontre l'utilisation typique.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GoGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85