This is the mail archive of the
gdb-patches@sources.redhat.com
mailing list for the GDB project.
Re: [RFA/doco] Add documentation for observer.[hc] (2nd version)
- From: "Eli Zaretskii" <eliz at elta dot co dot il>
- To: brobecker at gnat dot com
- Cc: gdb-patches at sources dot redhat dot com
- Date: Sun, 16 Mar 2003 19:58:03 +0200
- Subject: Re: [RFA/doco] Add documentation for observer.[hc] (2nd version)
- References: <20030310195959.GE972@gnat.com>
- Reply-to: Eli Zaretskii <eliz at elta dot co dot il>
> Date: Mon, 10 Mar 2003 11:59:59 -0800
> From: Joel Brobecker <brobecker at gnat dot com>
>
> Here is a second shot at the observer documentation. Hopefully, I
> addressed all issues.
Thanks. I still have a few comments.
> An observer is an entity who is interested in being notified when GDB
When you introduce a new term, such as "observer" in the above text,
it is best to put it into @dfn, like this:
An @dfn{observer} is an entity who is interested in being notified when GDB
(btw, it should be "whcih", not "who"). This makes the term stand
out, and clearly shows to the reader what is the term you introduce.
> The entity being observed is called the Subject.
Same here:
The entity being observed is called @dfn{the Subject}.
(Btw, is it really necessary to start "Subject" with a capital S?)
Please also make sure each sentence ends with either a newline or 2
spaces after the period.
Thanks!