FROM : Peter Duniho
DATE : Tue May 27 23:37:12 2008
> Date: Tue, 27 May 2008 16:48:23 -0400
> From: Andy Lee <<email_removed>>
>
> On May 27, 2008, at 4:15 PM, Peter Duniho wrote:
>>> Date: Tue, 27 May 2008 14:57:09 -0400
>>> From: Andy Lee <<email_removed>>
>>>
>>> Also, when we *do* ask to see people's code (which also happens),
>>> it's
>>> not because the code is the best way to express their intentions.
>>> It's because their code is not *fulfilling* their intentions.
>>> Not at
>>> all the same as code snippets in documentation.
>>
>> Au contraire!
>>
>> You are making the incorrect assumption that the documentation does
>> a 100% correct job of conveying intentions to every person who may
>> read it.
>
> I have no idea where you get this.
My apologies if I've misinterpreted what you wrote. I certainly know
how that feels.
My response was based on the synthesis of the points to which you
were responding and your own statement that the scenario of using
code as a communications tool when people are asking questions is
"not at all the same as code snippets in documentation".
If you agree with me that the documentation can in fact benefit from
the use of code snippets as a form of elaboration in the API
reference, then obviously I misunderstood.
Pete
DATE : Tue May 27 23:37:12 2008
> Date: Tue, 27 May 2008 16:48:23 -0400
> From: Andy Lee <<email_removed>>
>
> On May 27, 2008, at 4:15 PM, Peter Duniho wrote:
>>> Date: Tue, 27 May 2008 14:57:09 -0400
>>> From: Andy Lee <<email_removed>>
>>>
>>> Also, when we *do* ask to see people's code (which also happens),
>>> it's
>>> not because the code is the best way to express their intentions.
>>> It's because their code is not *fulfilling* their intentions.
>>> Not at
>>> all the same as code snippets in documentation.
>>
>> Au contraire!
>>
>> You are making the incorrect assumption that the documentation does
>> a 100% correct job of conveying intentions to every person who may
>> read it.
>
> I have no idea where you get this.
My apologies if I've misinterpreted what you wrote. I certainly know
how that feels.
My response was based on the synthesis of the points to which you
were responding and your own statement that the scenario of using
code as a communications tool when people are asking questions is
"not at all the same as code snippets in documentation".
If you agree with me that the documentation can in fact benefit from
the use of code snippets as a form of elaboration in the API
reference, then obviously I misunderstood.
Pete
| Related mails | Author | Date |
|---|---|---|
| Nathan | May 27, 00:48 | |
| Jens Alfke | May 27, 00:50 | |
| Nathan | May 27, 00:53 | |
| Nathan Kinsinger | May 27, 00:54 | |
| Nathan | May 27, 01:08 | |
| Michaël Villar | May 27, 01:13 | |
| Kyle Sluder | May 27, 01:13 | |
| Nathan Kinsinger | May 27, 01:13 | |
| Nathan | May 27, 01:19 | |
| Nathan | May 27, 01:25 | |
| Ken Thomases | May 27, 01:26 | |
| Ken Thomases | May 27, 01:27 | |
| Nathan Kinsinger | May 27, 01:28 | |
| Nathan | May 27, 01:30 | |
| Nathan | May 27, 01:32 | |
| Nathan Kinsinger | May 27, 01:50 | |
| Scott Ribe | May 27, 01:51 | |
| Johnny Lundy | May 27, 05:29 | |
| Graham Cox | May 27, 05:41 | |
| Greg Titus | May 27, 05:54 | |
| Nathan Kinsinger | May 27, 05:59 | |
| Graham Cox | May 27, 05:59 | |
| Roland King | May 27, 06:07 | |
| Ken Thomases | May 27, 06:10 | |
| Nathan Kinsinger | May 27, 06:10 | |
| Wayne Packard | May 27, 06:14 | |
| Adam Leonard | May 27, 06:28 | |
| Scott Ribe | May 27, 06:31 | |
| Graham Cox | May 27, 06:41 | |
| Michael Vannorsdel | May 27, 07:22 | |
| Peter Duniho | May 27, 09:18 | |
| Andy Lee | May 27, 10:05 | |
| Andy Lee | May 27, 11:27 | |
| Greg Titus | May 27, 17:05 | |
| Peter Duniho | May 27, 19:35 | |
| Andy Lee | May 27, 20:27 | |
| Hamish Allan | May 27, 20:36 | |
| Andy Lee | May 27, 20:57 | |
| Gary L. Wade | May 27, 21:47 | |
| Peter Duniho | May 27, 22:03 | |
| Peter Duniho | May 27, 22:15 | |
| Andy Lee | May 27, 22:48 | |
| Hamish Allan | May 27, 23:04 | |
| Peter Duniho | May 27, 23:30 | |
| Peter Duniho | May 27, 23:37 | |
| Andy Lee | May 27, 23:56 | |
| Scott Anguish | May 28, 00:09 |






Cocoa mail archive

