JuliaLang/julia

Add streams to interfaces manual

Open

#12,922 opened on Sep 2, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
docshelp wanted

Description

If someone wants to take a stab at it, might be nice to the IO-related contracts to http://julia.readthedocs.org/en/latest/manual/interfaces/.

Contributor guide

Tech stack
None
Domain
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Julia IOUnderstanding of documentation workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding documentation for IO related contracts (streams) to the manual at http://julia.readthedocs.org/en/latest/manual/interfaces/. Review the current interfaces manual page to understand the structure, then add a section describing the streams interface. Check existing Julia source code for IO implementations to derive the contracts. Ensure to follow the documentation style used in the manual.