From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 26031 invoked by alias); 5 Jan 2011 18:05: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: 15685 Received: (qmail 29127 invoked from network); 5 Jan 2011 18:04: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=-1.9 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received-SPF: pass (ns1.primenet.com.au: SPF record at ntlworld.com designates 81.103.221.47 as permitted sender) Date: Wed, 5 Jan 2011 18:04:49 +0000 From: Peter Stephenson To: Zsh Users Subject: Documentation change requests Message-ID: <20110105180449.2afff78b@pws-pc.ntlworld.com> X-Mailer: Claws Mail 3.7.8 (GTK+ 2.22.0; x86_64-redhat-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Cloudmark-Analysis: v=1.1 cv=JvdXmxIgLJv2/GthKqHpGJEEHukvLcvELVXUanXFreg= c=1 sm=0 a=kj9zAlcOel0A:10 a=HYshxDoSAAAA:8 a=NLZqzBF-AAAA:8 a=fGXdicqAdAd0NtZK7vgA:9 a=8rERNYS3DDGbHSZqNbAA:7 a=aGprLSWxr-mmqHoXyZpcnx7kTLcA:4 a=CjuIK1q_8ugA:10 a=MlPZ8bZMJJ0A:10 a=_dQi-Dcv4p4A:10 a=4xbha7r88BGVWplw:21 a=cpbeWg_OsW7Ckl59:21 a=HpAAvcLHHh0Zw7uRqdWCyQ==:117 We often get comments about the documentation being substandard. In future, it would help me a great deal if people concerned enough to want the manual changed could do as much work themselves as possible. Please could you edit the appropriate Yodl file from the zsh distribution and send zsh-workers@zsh.org a 'diff -u' ('diff -c' will do) of any changed files. If you don't have the latest CVS/git source the last distributed versions is usually fine, the documentation doesn't change that fast and even just looking at the diff helps me find what you're talking about. The files are in the subdirectory Doc/Zsh. They're basically plain text and I don't expect you to know anything about Yodl. - You don't need to do any formatting at all, just add some clearly marked text. - You don't need to make any attempt at definitive text and I don't care how bad your English is. I'm perfectly happy with comments pointing out the problem, e.g. !!!Shouldn't the manual point out this doesn't work with blah blah blah?!!! !!!For option -X it says blah blah, shouldn't it say the same here?!!! !!!I was expecting something about feature blah here, it was hard to find in its current location [please also mark that location with some text, anything will do, so I can compare]!!! !!!It doesn't really do 'blah', it actually does 'blech', so the wording needs improving!!! etc. etc. (Of course, if you *do* think you know what it should say please send that instead. To emphasise: actual diffs really do save a lot of time over descriptions of what needs changing.) It would help even more if you do this in all the relevant locations that you're aware of (e.g. for multiple features with similar effects) so I don't have to spend time hunting for things you already know about. This will save me considerable time since I won't have to go through the documentation trying to second guess where and what you're complaining about and in what way you think it could be improved. If you go through the exercise yourself, I think you'll see how much quicker it is if all I need to do is make an edit to something you've submitted rather than start hunting through files from scratch. I really do need all the help I can get. (I may repost this occasionally since I don't think there's another really good way of drawing list users' attention to it.) Thanks for your help. -- Peter Stephenson Web page now at http://homepage.ntlworld.com/p.w.stephenson/