Re: Documentation change requests

[Peter Stephenson <Peter.Stephenson@csr.com>]

On Thu, 6 Jan 2011 11:00:50 +0100
Štěpán Němec <stepnem@gmail.com> wrote:
> Peter Stephenson <p.w.stephenson@ntlworld.com> writes:
> 
> > We often get comments about the documentation being substandard.
> 
> 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.

-- 
Peter Stephenson <pws@csr.com>            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, Cambridge Business Park, Cowley Road, Cambridge, CB4 0WZ, United Kingdom