golang/go

net: clarify UDPConn Read behaviour documentation

Open

#31,991 opened on May 13, 2019

View on GitHub
 (3 comments) (4 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsFixhelp wanted

Repository metrics

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

Description

The documentation for UPDConn.Read says that "Read implements the Conn Read method." However, UDP is not stream and Conn is described as "a generic stream-oriented network connection".

It would be nice to be able to know what the characteristics of Read are with respect to packets — whether Read only reads a packet at a time or not — without having to read the source.

See https://groups.google.com/forum/#!topic/golang-nuts/f_s3fGRgAF8

Contributor guide

Research direction
Examine the current UDPConn.Read documentation in the Go net package source, review the related discussion in golang nuts, and propose a clarification that specifies whether Read reads one packet at a time or not.
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.
2
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.
75