[Issue 19567] New: [std.stdio] Not really helpful documentation of `tell`
d-bugmail at puremagic.com
d-bugmail at puremagic.com
Wed Jan 9 14:49:28 UTC 2019
https://issues.dlang.org/show_bug.cgi?id=19567
Issue ID: 19567
Summary: [std.stdio] Not really helpful documentation of `tell`
Product: D
Version: D2
Hardware: All
URL: http://dlang.org/phobos/
OS: All
Status: NEW
Severity: enhancement
Priority: P3
Component: phobos
Assignee: nobody at puremagic.com
Reporter: desisma at heidel.beer
`const @property @trusted ulong tell()` is documented in a not really useful
way. It comes with the assumption the user already knows how `ftell` works and
what it does.
> Calls ftell for the managed file handle.
>
> Throws:
> Exception if the file is not opened. ErrnoException if the call to ftell fails.
Instead of being told to lookup on `ftell` (which is implicitly done by linking
its docs with no further explanation), I'd expect to actually the docs to let
me know what `tell` does.
Moreover, `write` is *not* documented as "more powerful D equivalent of printf"
either. Instead it comes with the helpful info, "Writes its arguments in text
format to standard output (without a trailing newline)".
Kind regards,
Elias
--
More information about the Digitalmars-d-bugs
mailing list