JuliaLang/julia

Add streams to interfaces manual

Open

#12.922 geöffnet am 2. Sept. 2015

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (5.773 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (48.709 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 6h) (157 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Das Issue fordert die Ergänzung der Dokumentation für IO bezogene Verträge (Streams) im Handbuch unter http://julia.readthedocs.org/en/latest/manual/interfaces/. Überprüfen Sie die aktuelle Seite des Interfaces Handbuchs, um die Struktur zu verstehen, und fügen Sie dann einen Abschnitt hinzu, der die Streams Schnittstelle beschreibt. Überprüfen Sie vorhandenen Julia Quellcode auf IO Implementierungen, um die Verträge abzuleiten. Stellen Sie sicher, dass Sie dem im Handbuch verwendeten Dokumentationsstil folgen.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90