From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#55527: 28.1; Clearer abbrev docstrings Date: Thu, 19 May 2022 22:46:51 +0300 Message-ID: <838rqxcnkk.fsf@gnu.org> References: <83bkvtcq38.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29533"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55527@debbugs.gnu.org To: Howard Melman Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu May 19 21:48:30 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 1nrm8M-0007V5-Ma for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 19 May 2022 21:48:30 +0200 Original-Received: from localhost ([::1]:48818 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nrm8L-0006O0-E9 for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 19 May 2022 15:48:29 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53682) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nrm7u-0006Mt-4M for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 15:48:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:42754) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nrm7t-0002W3-Pn for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 15:48:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nrm7t-0003C5-OG for bug-gnu-emacs@gnu.org; Thu, 19 May 2022 15:48:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 19 May 2022 19:48:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55527 X-GNU-PR-Package: emacs Original-Received: via spool by 55527-submit@debbugs.gnu.org id=B55527.165298962212053 (code B ref 55527); Thu, 19 May 2022 19:48:01 +0000 Original-Received: (at 55527) by debbugs.gnu.org; 19 May 2022 19:47:02 +0000 Original-Received: from localhost ([127.0.0.1]:36650 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nrm6w-00038G-88 for submit@debbugs.gnu.org; Thu, 19 May 2022 15:47:02 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:60086) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nrm6t-00037m-Sb for 55527@debbugs.gnu.org; Thu, 19 May 2022 15:47:00 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:34748) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nrm6o-0002NU-FA; Thu, 19 May 2022 15:46:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=2SXDzZjPUamarJc9OQ35Gz5nJUFrq9syX2ZUeEMObNk=; b=jc0KQ3wRpHgy 2nwAzXfad1SsUJTCmW/i+0vH62nQ53RLPejslSo733ZQyyH09zNAhP46ZgYQfM//1MiVUQzPYFnRv kVIJ9+DqC5cYzh6dP5nCzyWnp8IHjo+FAkxEH3W87l4Id2WuMfRVQ2oEfPRikKIptn+vevDXJbcOU 3zjPeOfksKzIzi0SjvAHnM9IjjOE/r0Ei1zdpYSRGZ191Mx7WVHTXGM+EYv6sLNWjN3Ul8meFd/lX 6f72z555CaYZ6JCtPYgKAvMlHsBXNAqTuV7tXpYIn/XBipu33WvX3lne4OlQC/uG5wLsdGsJ409IY MPZfLX7xnT5XAZh8lahiww==; Original-Received: from [87.69.77.57] (port=3057 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nrm6n-0002Qa-VC; Thu, 19 May 2022 15:46:54 -0400 In-Reply-To: (message from Howard Melman on Thu, 19 May 2022 15:30:18 -0400) 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:232665 Archived-At: > 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 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. > >> (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?