From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 389 invoked by alias); 6 Jan 2011 11:25:00 -0000 Mailing-List: contact zsh-users-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Users List List-Post: List-Help: X-Seq: 15689 Received: (qmail 8547 invoked from network); 6 Jan 2011 11:24:57 -0000 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on f.primenet.com.au X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_LOW, SPF_HELO_PASS autolearn=ham version=3.3.1 Received-SPF: none (ns1.primenet.com.au: domain at csr.com does not designate permitted sender hosts) Date: Thu, 6 Jan 2011 10:51:05 +0000 From: Peter Stephenson To: Zsh Users Subject: Re: Documentation change requests Message-ID: <20110106105105.3dcc445c@pwslap01u.europe.root.pri> In-Reply-To: <87r5cq5p2l.fsf@gmail.com> References: <20110105180449.2afff78b__23492.6510871903$1294250894$gmane$org@pws-pc.ntlworld.com> <87r5cq5p2l.fsf@gmail.com> Organization: Cambridge Silicon Radio X-Mailer: Claws Mail 3.7.6 (GTK+ 2.20.1; i386-redhat-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-OriginalArrivalTime: 06 Jan 2011 10:51:06.0096 (UTC) FILETIME=[9E7AAF00:01CBAD8F] X-Scanned-By: MailControl A_10_80_00 (www.mailcontrol.com) on 10.71.0.135 On Thu, 6 Jan 2011 11:00:50 +0100 =C5=A0t=C4=9Bp=C3=A1n N=C4=9Bmec wrote: > Peter Stephenson writes: >=20 > > We often get comments about the documentation being substandard. >=20 > Interesting. I don't remember seeing any such comments. In any case, > let me say that I consider Zsh documentation definitely > superstandard[1]. ;-) As is probably already clear from the examples I gave, I really meant 'inaccurate' (which is the particular concern) or 'needing improvement'. However, I think we do sometimes get comments where someone has been confused by the documentation and says so. The trouble is it's usually not possible to work out from someone's confusion what to do to improve the docs. That's why I'm really keen on getting suggestions afterwards that say explicitly I got confused *here* and I could have done with a better pointer *here*. If someone was confused and has been put in the right direction by the list, this should be useful for future readers. --=20 Peter Stephenson Software Engineer Tel: +44 (0)1223 692070 Cambridge Silicon Radio Limited Churchill House, Cambridge Business Park, Cowley Road, Cambridge, CB4 0WZ, = UK Member of the CSR plc group of companies. CSR plc registered in England and= Wales, registered number 4187346, registered office Churchill House, Cambr= idge Business Park, Cowley Road, Cambridge, CB4 0WZ, United Kingdom