curl_easy_setopt man page: Clarification about passed in string storage #7632
I see many other issues use a template that has "I did this" and "I expect the following" to report bugs. This issue is not about a bug but I'm hoping for some clarification about the document of
The doc says:
I was confused by the words "... may be overwritten ..." when I initially read it because the sentence doesn't explicitly mention the actor of "overwrite". As a result, being a non-English speaker myself, my first impression was "the string storage could be overwritten (by
After reading the entire page, I think the words mean:
Am I understanding the document correctly?
If my understanding above is correct, can we refine the document as follows?
Firstly, avoid using "... may be overwritten ..." but clearly state what the programmer can do with the string storage. Something like below:
Or, if passive voice is preferred, the doc could be refined as follows:
Secondly, put the note "Before version 7.17.0, strings were not copied." right after the sentence above in order to create a closer link. So my final suggestion is:
(In active voice)
(In passive voice)
The text was updated successfully, but these errors were encountered: