D issues are now tracked on GitHub. This Bugzilla instance remains as a read-only archive.
Issue 6826 - stdio.File.readf docs incorrect
Summary: stdio.File.readf docs incorrect
Status: RESOLVED FIXED
Alias: None
Product: D
Classification: Unclassified
Component: phobos (show other issues)
Version: D2
Hardware: Other Linux
: P2 normal
Assignee: No Owner
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-10-18 09:06 UTC by Jerry Quinn
Modified: 2012-02-25 13:10 UTC (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this issue.
Description Jerry Quinn 2011-10-18 09:06:28 UTC 
The docs for readf() say:

    Formatted read one line from stdin.

However, this function doesn't read a whole line as the text implies.  Or at least I hope it doesn't.  It would be better to say it extracts characters from the file using format.readFormatted().
Comment 1 Jerry Quinn 2011-10-18 11:47:35 UTC 
Also, I assume the return value is the one generated by readFormatted(), but it should be explicitly stated.