D issues are now tracked on GitHub. This Bugzilla instance remains as a read-only archive.
Issue 19567 - [std.stdio] Not really helpful documentation of `tell`
Summary: [std.stdio] Not really helpful documentation of `tell`
Status: RESOLVED FIXED
Alias: None
Product: D
Classification: Unclassified
Component: phobos (show other issues)
Version: D2
Hardware: All All
: P4 enhancement
Assignee: No Owner
URL: http://dlang.org/phobos/
Keywords: pull
Depends on:
Blocks:
 
Reported: 2019-01-09 14:49 UTC by Elias Batek (0xEAB)
Modified: 2023-01-31 23:18 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Elias Batek (0xEAB) 2019-01-09 14:49:28 UTC
`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
Comment 1 Dlang Bot 2023-01-31 20:22:29 UTC
@roscarares created dlang/phobos pull request #8673 "Fix Issue 19567" fixing this issue:

- Fix Issue 19567

https://github.com/dlang/phobos/pull/8673
Comment 2 Dlang Bot 2023-01-31 23:18:36 UTC
dlang/phobos pull request #8673 "Fix Issue 19567" was merged into master:

- 82e957f8294fbebca973eca967309e93bb049d1e by Rosca Rares:
  Fix Issue 19567

https://github.com/dlang/phobos/pull/8673