Bug 8086 – std.stdio is underdocumented

Status
RESOLVED
Resolution
FIXED
Severity
normal
Priority
P2
Component
phobos
Product
D
Version
D2
Platform
All
OS
All
Creation time
2012-05-11T12:13:00Z
Last change time
2014-06-06T21:31:13Z
Assigned to
nobody
Creator
bugzilla

Comments

Comment #0 by bugzilla — 2012-05-11T12:13:37Z
1. byLine is documented to return a LinesReader, but that is the only mention of LinesReader anywhere 2. stdin and stdout are mentioned in passing several times, but they need their own entries explaining what they are 3. LinesReader should say that it has an element type of dchar, decoding UTF8 as required 4. The canoncial program to read from stdin and write to stdout should be given as an example: import std.stdio; import std.algorithm; void main() { stdin.byChunk(1024).copy(stdout.lockingTextWriter()); } 5. byChunk should document what its element type is 6. byDchar is undocumented
Comment #1 by nick — 2013-07-17T04:51:19Z
(In reply to comment #0) > 1. byLine is documented to return a LinesReader, but that is the only > mention of LinesReader anywhere Now fixed in git master. ... > 3. LinesReader should say that it has an element type of dchar, decoding UTF8 > as required Assuming you meant ByLine, byLine now documents that the element type is Char[]. UTF8 decoding is not mentioned though. ... > 6. byDchar is undocumented Doesn't seem to exist now.
Comment #2 by justin — 2014-06-06T21:31:13Z
I believe all of these concerns have been addressed in the documentation, in particular 4 is given in the byChunk examples.