www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 19567] New: [std.stdio] Not really helpful documentation of


          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 puremagic.com
          Reporter: desisma 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.

 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 --
Jan 09 2019