golang/go

net: Resolver.LookupIP: document should clarify the return values

Open

#43,506 创建于 2021年1月5日

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

仓库指标

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

描述

The current document on net.Resolver.LookupIP was not clear on the return values (i.e. what to expect when err is nil).

Looking into the source code, LookupIP uses internetAddrList here, and the comment for internetAddrList here does state the slice would contain at least one IP when err is nil.

We should duplicate the comment of internetAddrList to LookupIP.

贡献者指南

研究方向
在 src/net/lookup.go 中找到 LookupIP 函数，并添加来自 src/net/ipsock.go 中 internetAddrList 的注释，以说明当 err 为 nil 时返回的切片至少包含一个 IP。
技术栈
go
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GoGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90