From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Howard Melman Newsgroups: gmane.emacs.bugs Subject: bug#55527: 28.1; Clearer abbrev docstrings Date: Thu, 19 May 2022 16:38:42 -0400 Message-ID: References: <83bkvtcq38.fsf@gnu.org> <838rqxcnkk.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35309"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.1 (darwin) To: 55527@debbugs.gnu.org Cancel-Lock: sha1:0lcbj2zbpscfb7voQap/zv2Vg4Q= Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu May 19 22:39:11 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nrmvP-00096Q-Sj for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 19 May 2022 22:39:11 +0200 Original-Received: from localhost ([::1]:60602 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nrmvO-0005KC-Gg for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 19 May 2022 16:39:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33118) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nrmvG-0005IY-VY for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 16:39:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:42787) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nrmvG-0000tM-Mk for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 16:39:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nrmvG-0004P4-CY for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 16:39:02 -0400 X-Loop: help-debbugs@gnu.org In-Reply-To: Resent-From: Howard Melman Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 19 May 2022 20:39:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55527 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.165299273916916 (code B ref -1); Thu, 19 May 2022 20:39:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 19 May 2022 20:38:59 +0000 Original-Received: from localhost ([127.0.0.1]:36684 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nrmvC-0004Om-PW for submit@debbugs.gnu.org; Thu, 19 May 2022 16:38:59 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:60558) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nrmvB-0004Of-Lu for submit@debbugs.gnu.org; Thu, 19 May 2022 16:38:58 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33114) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nrmvA-0005CQ-M2 for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 16:38:57 -0400 Original-Received: from ciao.gmane.io ([116.202.254.214]:44904) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nrmv8-0000rq-HB for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 16:38:55 -0400 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1nrmv6-0008hR-Hh for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 22:38:52 +0200 X-Injected-Via-Gmane: http://gmane.org/ Received-SPF: pass client-ip=116.202.254.214; envelope-from=geb-bug-gnu-emacs@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: 5 X-Spam_score: 0.5 X-Spam_bar: / X-Spam_report: (0.5 / 5.0 requ) BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, FORGED_GMAIL_RCVD=1, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.249, NML_ADSP_CUSTOM_MED=0.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:232666 Archived-At: Eli Zaretskii writes: >> From: Howard Melman >> Date: Thu, 19 May 2022 15:30:18 -0400 >> >> > I don't actually understand what's wrong with the original one, >> > viz.: >> > >> > Define last word before point as a global (mode-independent) abbrev. >> >> Because I'm not sure if the word will be used as the abbrev >> or the expansion. > > If you add the expansion part, the line becomes too long, though: > > Define last word before point as expansion of a global (mode-independent) abbrev. I think you can loose the "mode-independent" part, as global covers that pretty clearly, how about: Define last word before point as expansion of a global abbrev. >> > I would say >> > >> > Global abbrev that expands into "foo": >> > Expansion for a global abbrev "foo": >> >> Those would be fine with me. >> >> > But I'm not sure we can make these prompts so much longer than the >> > original ones without overflowing the minibuffer into a second line, >> > which is a disadvantage. >> >> I tend to use very short abbrevs that expand into longer >> words, so it wouldn't be a problem for me. > > The problem in the first prompt is with "foo": it could be arbitrarily > long. And in the second prompt you are supposed to type the > expansion, which again can be long. Yes but I'm adding about 10 characters to the prompt, so once you get to "arbitrarily long", 10 characters only affects so many of them :) >> >> (defun define-abbrev (table abbrev expansion &optional hook &rest props) >> >> "Define in TABLE an ABBREV and its EXPANSION and optionally a HOOK. >> > >> > This loses the explanation of what is HOOK, and is also a very awkward >> > sentence that I think will be hard on non-native English >> > speakers. >> >> I'm not sure that "call HOOK" is an "explanation". I >> already assumed a "hook" would be called and I was confused >> when it would be called. > > It will be called, but by whom and when? Yes that was *my* point. The original says: Define an abbrev in TABLE named NAME, to expand to EXPANSION and call HOOK. which to me doesn't answer "by whom and when" and I think is actually less clear than my rewording. Perhaps better is: Define in TABLE an ABBREV and its EXPANSION and optionally its HOOK. I don't think it's at all obvious how the original clauses relate to each other (thankfully the full docstring is much clearer) but as you brought up non-native english speakers I would think the original is also difficult for them. -- Howard