From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 24723 invoked by alias); 16 Mar 2003 18:03:22 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 24684 invoked from network); 16 Mar 2003 18:03:22 -0000 Received: from unknown (HELO gandalf.inter.net.il) (192.114.186.22) by sources.redhat.com with SMTP; 16 Mar 2003 18:03:22 -0000 Received: from zaretsky ([80.230.235.131]) by gandalf.inter.net.il (Mirapoint Messaging Server MOS 3.2.2-GA) with ESMTP id AIW72962; Sun, 16 Mar 2003 20:03:12 +0200 (IST) Date: Sun, 16 Mar 2003 18:03:00 -0000 From: "Eli Zaretskii" To: brobecker@gnat.com Message-Id: <2593-Sun16Mar2003195803+0200-eliz@elta.co.il> CC: gdb-patches@sources.redhat.com In-reply-to: <20030310195959.GE972@gnat.com> (message from Joel Brobecker on Mon, 10 Mar 2003 11:59:59 -0800) Subject: Re: [RFA/doco] Add documentation for observer.[hc] (2nd version) Reply-to: Eli Zaretskii References: <20030310195959.GE972@gnat.com> X-SW-Source: 2003-03/txt/msg00347.txt.bz2 > Date: Mon, 10 Mar 2003 11:59:59 -0800 > From: Joel Brobecker > > 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!