Bug 19567 – [std.stdio] Not really helpful documentation of `tell`
Status
RESOLVED
Resolution
FIXED
Severity
enhancement
Priority
P4
Component
phobos
Product
D
Version
D2
Platform
All
OS
All
Creation time
2019-01-09T14:49:28Z
Last change time
2023-01-31T23:18:36Z
Keywords
pull
Assigned to
No Owner
Creator
Elias Batek (0xEAB)
Comments
Comment #0 by desisma — 2019-01-09T14:49:28Z
`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