golang/go

net: better docs for PreferGo in Resolver

Open

#35,561 opened on Nov 13, 2019

View on GitHub
 (8 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

Guys, how are you?

I have a suggestion to improve doc about parameter PreferGo on struct Resolver based on a comment in another issue. https://github.com/golang/go/issues/19268#issuecomment-345384876

Suggestion adds more a small text:

When you use the variable PreferGo set to true you will be 
able to use your dial, If you use PreferGo set to false it will ignore 
your dial and use directly "/etc/resolv.conf "

Reference Doc: https://github.com/golang/go/blob/a38a917aee626a9b9d5ce2b93964f586bf759ea0/src/net/lookup.go#L120

Contributor guide

Research direction
Review the existing documentation for PreferGo at src/net/lookup.go:120 and the context from issue #19268 comment, then craft a concise, accurate doc improvement that clarifies when PreferGo affects dial behavior.
Tech stack
go
Domain
backend
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.
Under 1 hour
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90