golang/go

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

Open

#59,321 创建于 2023年3月29日

在 GitHub 查看
 (6 评论) (0 反应) (0 负责人)Go (19,008 fork)batch import
DocumentationNeedsInvestigationhelp wanted

仓库指标

Star
 (133,883 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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.

贡献者指南

研究方向
识别math/big包中缺少示例的函数。参考Go标准库中的现有示例以了解如何编写可测试的示例。为每个函数编写一个可运行的示例，展示典型用法。
技术栈
go
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GoGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85