On Friday, October 21, 2022 at 9:14:16 AM UTC-4 Edward K. Ream wrote:

> On Thursday, October 20, 2022 at 7:59:40 AM UTC-5 Edward K. Ream wrote:
>
> We recently discussed the role of comments and narratives in our programs. 
>> coverage has some of the best docstrings I've ever seen.  Two longish 
>> examples: [snip]
>>
>
> Notice the contingent and pragmatic nature of these (excellent!) comments:
>
> - They depend on the actual code: they could not have been written 
> beforehand.
> - They are *not* part of a general narrative: they discuss low-level 
> details or bugs.
>

And they are essential for understanding why the code is there and is the 
way it is.  I don't think reading the same code without the comments would 
let any normal person modify or rewrite the code without messing up the 
program's desired operation.

-- 
You received this message because you are subscribed to the Google Groups 
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/leo-editor/dcf22d9d-cac7-4bdb-acfa-2f5ff8bf0407n%40googlegroups.com.

Reply via email to