From: Robert Dewar <dewar@adacore.com>
To: Robert Dewar <dewar@adacore.com>
Cc: Eli Zaretskii <eliz@gnu.org>,
pkoning@equallogic.com, jimb@codesourcery.com,
eager@eagercon.com, stanshebs@earthlink.net,
gdb@sources.redhat.com
Subject: Re: What's an annex? stratum?
Date: Mon, 25 Jun 2007 21:06:00 -0000 [thread overview]
Message-ID: <46802E5C.4090408@adacore.com> (raw)
In-Reply-To: <46802D87.3040509@adacore.com>
Robert Dewar wrote:
> Eli Zaretskii wrote:
>
>> You aren't familiar with my standards of ``adequate comments''.
>
> Well then you probably are not familiar with the GNAT front end :-)
>
> To me, code that is lacking in full documentation is unacceptable
> (yes, most code around meets that criterion).
Just to be clearer, I mean most code around is indeed lacking in
full documentation. In particular, things that are often missing
are
global documentation (yes, this can be in separate documents if
they are kept up to date).
local documentation that does NOT depend on guessing what variable
names mean, or reading what code does.
In particular documentation about what you did NOT do and why not
(that's something you definitely cannot deduce from the code, but
is often very important).
next prev parent reply other threads:[~2007-06-25 21:06 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-06-23 18:01 Michael Eager
2007-06-23 18:57 ` Stan Shebs
2007-06-23 19:08 ` Michael Eager
2007-06-23 19:47 ` Eli Zaretskii
2007-06-23 20:51 ` Michael Eager
2007-06-23 21:23 ` Daniel Jacobowitz
2007-06-23 21:40 ` Michael Eager
2007-06-24 2:58 ` Eli Zaretskii
2007-06-24 4:32 ` Michael Eager
2007-06-25 18:03 ` Jim Blandy
2007-06-25 18:39 ` Michael Eager
2007-06-25 19:10 ` Jim Blandy
2007-06-25 19:26 ` Paul Koning
2007-06-25 19:32 ` Daniel Jacobowitz
2007-06-25 19:38 ` Robert Dewar
2007-06-25 19:48 ` Paul Koning
2007-06-25 20:09 ` Michael Eager
2007-06-25 20:40 ` Robert Dewar
2007-06-25 20:47 ` Robert Dewar
2007-06-25 20:31 ` Eli Zaretskii
2007-06-25 20:44 ` Robert Dewar
2007-06-25 21:00 ` Eli Zaretskii
2007-06-25 21:03 ` Robert Dewar
2007-06-25 21:06 ` Robert Dewar [this message]
2007-06-26 18:34 ` Markus Deuling
2007-06-26 18:36 ` Robert Dewar
2007-06-26 21:55 ` Jim Blandy
2007-06-26 22:14 ` Nick Roberts
2007-06-26 23:26 ` Robert Dewar
2007-06-26 23:39 ` Joel Brobecker
2007-06-26 23:43 ` Robert Dewar
2007-06-27 0:32 ` Jim Blandy
2007-06-27 0:42 ` Robert Dewar
2007-06-27 3:22 ` Eli Zaretskii
2007-06-27 0:23 ` Michael Eager
2007-06-25 20:42 ` Eli Zaretskii
2007-06-25 20:23 ` Eli Zaretskii
2007-06-25 21:52 ` Jim Blandy
2007-06-26 1:04 ` Paul Koning
2007-06-25 20:37 ` Eli Zaretskii
2007-06-25 20:15 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=46802E5C.4090408@adacore.com \
--to=dewar@adacore.com \
--cc=eager@eagercon.com \
--cc=eliz@gnu.org \
--cc=gdb@sources.redhat.com \
--cc=jimb@codesourcery.com \
--cc=pkoning@equallogic.com \
--cc=stanshebs@earthlink.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox