Insufficient Documentation?

Jesse Phillips jessek.phillips+D at gmail.com
Tue Jul 30 23:43:22 PDT 2013


On Wednesday, 31 July 2013 at 04:05:48 UTC, Manfred Nowak wrote:
> Jesse Phillips wrote:
> How did you know about "convert object"?
>
> -manfred

If I had an object (argument) then I'd want to know how it would 
become (convert to) "text." Similarly if I had an int I'd want to 
know how that converts to text. If I didn't know what an argument 
was:

https://www.google.com/search?q=what+is+a+function+argument

You mentioned that nothing came up about toString, if information 
on toString was applicable to you then it is likely because your 
argument being passed was an object (of a class or a struct). 
Thus the question becomes how does my object convert to text for 
this write function. To further that, strings are the type of 
text so if I am familiar with any language I can attempt to be 
more specific.

I just don't understand why you think "arguments in text format" 
should direct you toward toString. At most I could see 
std.string.format, but I doubt that would answer the question. I 
certainly could see reason for the documentation of write to 
mention toString, but based on the information provided it is 
hard to say what about "Writes its arguments in text format to 
the file" is unclear.

I feel, "
  Converts all arguments to strings and catenates those strings to
    `File' in lexical order of appearance of the arguments."

Needlessly complicates communicating the operation performed. But 
maybe it is of value to most people.


More information about the Digitalmars-d-learn mailing list