From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel Subject: desktop-missing-file-warning doc Date: Sat, 13 May 2006 17:36:49 -0500 (CDT) Message-ID: <200605132236.k4DManEm007081@jane.dms.auburn.edu> NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1147559892 8662 80.91.229.2 (13 May 2006 22:38:12 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 13 May 2006 22:38:12 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun May 14 00:38:11 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1Ff2kU-0002lH-Hv for ged-emacs-devel@m.gmane.org; Sun, 14 May 2006 00:38:10 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Ff2kU-0002Xa-5I for ged-emacs-devel@m.gmane.org; Sat, 13 May 2006 18:38:10 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Ff2kI-0002Vq-Fm for emacs-devel@gnu.org; Sat, 13 May 2006 18:37:58 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Ff2kE-0002V9-5d for emacs-devel@gnu.org; Sat, 13 May 2006 18:37:57 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Ff2kD-0002Uj-Vs for emacs-devel@gnu.org; Sat, 13 May 2006 18:37:54 -0400 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.52) id 1Ff2mH-0006tW-81 for emacs-devel@gnu.org; Sat, 13 May 2006 18:40:01 -0400 Original-Received: from jane.dms.auburn.edu (jane.dms.auburn.edu [131.204.53.201]) by manatee.dms.auburn.edu (8.13.6/8.13.6) with ESMTP id k4DMbq2t005843; Sat, 13 May 2006 17:37:53 -0500 (CDT) Original-Received: from jane.dms.auburn.edu (localhost [127.0.0.1]) by jane.dms.auburn.edu (8.13.4+Sun/8.13.4) with ESMTP id k4DMansS007084; Sat, 13 May 2006 17:36:49 -0500 (CDT) Original-Received: (from teirllm@localhost) by jane.dms.auburn.edu (8.13.4+Sun/8.13.3/Submit) id k4DManEm007081; Sat, 13 May 2006 17:36:49 -0500 (CDT) X-Authentication-Warning: jane.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: emacs-devel@gnu.org X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:54406 Archived-At: `(elisp)Documentation Tips' states that the first line of a docstring should not be wider than 67 characters. The stated reason for that is that otherwise it looks bad in apropos output. But for defcustoms, another reason is that if the first line is too long, it can look really bad in a Custom buffer. Just do `M-x customize-group desktop RET' and look at desktop-missing-file-warning (assuming the default 80 chars per line). The first line of desktop-missing-file-warning is way too long: If non-nil then `desktop-read' asks if a non-existent file should be recreated. It has other problems. If you just look at that first line, you get the impression that if the value is nil, `desktop-read' creates the file without asking, especially given the -warning at the end of the name. That is not what happens. Since it seems impossible to recreate a file that never existed, I guess that non-existent means deleted. The current first line uses the passive and there is another convention to avoid that if it is unnecessary. What about the following alternative first line, which reduces the length of the first line to 60 characters, does not use passive and in addition is also, I believe, clearer and easier to read. I could install if desired. ===File ~/desktop.el-diff=================================== *** desktop.el 13 May 2006 11:24:56 -0500 1.100 --- desktop.el 13 May 2006 16:56:13 -0500 *************** *** 201,207 **** :version "22.1") (defcustom desktop-missing-file-warning nil ! "*If non-nil then `desktop-read' asks if a non-existent file should be recreated. Also pause for a moment to display message about errors signaled in `desktop-buffer-mode-handlers'. --- 201,207 ---- :version "22.1") (defcustom desktop-missing-file-warning nil ! "If non-nil,`desktop-read' offers to recreate a deleted file. Also pause for a moment to display message about errors signaled in `desktop-buffer-mode-handlers'. ============================================================