golang/go

x/website/_content/tour: add a thorough discussion of the io interfaces

Open

#11,373 opened on Jun 24, 2015

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

Repository metrics

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

Description

We ask the reader to implement an io.Reader, but it doesn't actually read from anything. It can be hard to see why this is a "Reader", or indeed what a "Reader" is. I think we need more detail on this topic.

Contributor guide

Research direction
Review the current tour section on io interfaces and draft expanded content explaining the Reader interface with concrete examples.
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