golang/go

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

Open

#59.321 geöffnet am 29. März 2023

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (19.008 Forks)batch import
DocumentationNeedsInvestigationhelp wanted

Repository-Metriken

Stars
 (133.883 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Identifizieren Sie Funktionen im Paket math/big, denen Beispiele fehlen. Schauen Sie sich vorhandene Beispiele in der Go Standardbibliothek an, um zu erfahren, wie Sie testbare Beispiele schreiben. Schreiben Sie für jede Funktion ein ausführbares Beispiel, das die typische Verwendung demonstriert.
Tech Stack
go
Domain
documentation
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.
1-3 Stunden
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
GoGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85