golang/go

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

Open

#59,321 opened on Mar 29, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Identify functions in the math/big package that lack examples. Look at existing examples in the Go standard library for guidance on how to write testable examples. For each function, write a runnable example that demonstrates typical usage.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85