From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Justin Burkett Newsgroups: gmane.emacs.bugs Subject: bug#68929: [PATCH] Copy which-key from GNU ELPA into core Date: Mon, 5 Feb 2024 21:51:04 -0500 Message-ID: References: <871q9rvqbi.fsf@jeremybryant.net> <86wmrj148c.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1836"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Jeremy Bryant , 68929@debbugs.gnu.org, monnier@iro.umontreal.ca To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Feb 06 03:52:09 2024 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 1rXBZB-0000Hq-4f for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 06 Feb 2024 03:52:09 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rXBYt-0005X8-ED; Mon, 05 Feb 2024 21:51:51 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rXBYr-0005Wm-Up for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2024 21:51:49 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rXBYr-0000Nh-NJ for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2024 21:51:49 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rXBZ4-00043Z-65 for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2024 21:52:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Justin Burkett Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 06 Feb 2024 02:52:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68929 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 68929-submit@debbugs.gnu.org id=B68929.170718790215565 (code B ref 68929); Tue, 06 Feb 2024 02:52:02 +0000 Original-Received: (at 68929) by debbugs.gnu.org; 6 Feb 2024 02:51:42 +0000 Original-Received: from localhost ([127.0.0.1]:52965 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXBYi-00042x-Ib for submit@debbugs.gnu.org; Mon, 05 Feb 2024 21:51:42 -0500 Original-Received: from mail-ed1-x532.google.com ([2a00:1450:4864:20::532]:60608) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXBYc-00042e-FJ for 68929@debbugs.gnu.org; Mon, 05 Feb 2024 21:51:38 -0500 Original-Received: by mail-ed1-x532.google.com with SMTP id 4fb4d7f45d1cf-5608f7fd83cso1041959a12.0 for <68929@debbugs.gnu.org>; Mon, 05 Feb 2024 18:51:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=burkett-cc.20230601.gappssmtp.com; s=20230601; t=1707187876; x=1707792676; darn=debbugs.gnu.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=TVxfcz8Rr0nJWgCO3ERIgDL+F9/M72H+bSmgpseBhBY=; b=fbHoJQH8LB/Zm9YtMixbjRdsW1dcK555W+jNwKpeau93dzYunIkYmIU2BjHDvbfJfZ 2lTVzY8B9dEyi3aqYGYrD/9nnzeJHTs9TfOsFLmDUTZiBzy1IJhAlHjihO6/cNSlgbnd MdE15pPdGkSsH+m/X7XedlxQz7zbEHQp/zS9asZeUgn7tjz4sVNfIrUb2YtrgATMNU+f 7zWKBLytKiGG+JSN6GdSAC9ZTjkqATpIaJRjIkT95IlEIaidxyD+IsXOQmCdezChsa4S oegWlL2SEYrpfesVRXCvm0JvbwQoL3wMowHTqmYxz3IL5KgDXTUXQM+gP3tJR4TnTxQH YLzQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707187876; x=1707792676; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=TVxfcz8Rr0nJWgCO3ERIgDL+F9/M72H+bSmgpseBhBY=; b=jWzoDV2RtVJlL1JCPzg/je2dFk31uGChJPyVLJd5/ALsDGVQfBNW0TPBi4G1O/4k3Z GobMrJA9KsPnu5iaSfstcQuz6jQn9SSjF6XMWWaJO5t95YoojuezTa21FAYwu8xhGa/m nE8OyYiN88g4xBhHjE9U1uoOOmiZndkOAto9jfK5muJ7Dx1bxadav1E+iZ2/D5iMYkqP 8LeVuAZ8KAxTAyVbZx/YNRfuKJsDxAymMNsj3ixWrpWVhh6OphF+5LxKx4TRcy++yLz8 dIajMvjCgvS7gTWlbLS8vkYXhdfyXgCNV0pjkf6hYYyDk+uviskZsXYu2FCUMiYOkKAV dXQw== X-Gm-Message-State: AOJu0YxKif1VIF5yZSnUUm6WRJK+YNMEITnmpK0gnw1s+0znFgMJ8yla JNnLn+gJTZnlpkY7wVWVy59KXPzXVInsEpteqzAcn95x6vFwGDAY1mDOahsG8rvkoUyhgw2l2EL PqOiQkjiGXlx5iXRiFUed+g0+VnoQqqaLxSY9bQ== X-Google-Smtp-Source: AGHT+IFmTi1uNovEV0T+SliVVdY4ePK5yDpR3gnzEtHnKaZqx+bJNwPLjM9sxA8MGrrVWYnNTvIRYwL38kfrguWTwJ0= X-Received: by 2002:aa7:da50:0:b0:55f:a7d6:fd6a with SMTP id w16-20020aa7da50000000b0055fa7d6fd6amr567796eds.5.1707187875705; Mon, 05 Feb 2024 18:51:15 -0800 (PST) In-Reply-To: <86wmrj148c.fsf@gnu.org> 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-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:279471 Archived-At: Thanks for the comments. I'll work on these. On Mon, Feb 5, 2024 at 7:32=E2=80=AFAM Eli Zaretskii wrote: > > > Date: Sun, 04 Feb 2024 22:02:50 +0000 > > From: Jeremy Bryant via "Bug reports for GNU Emacs, > > the Swiss army knife of text editors" > > > > This patch brings the latest version of which-key from GNU ELPA into > > Emacs core > > > > If suitable I will then work on the updates to user-facing aspects such= as > > manual and NEWS. > > This "needs work"... Based on a very superficial reading of this huge > file: > > > +;; which-key provides the minor mode which-key-mode for Emacs. The mod= e displays > ^^ > Two spaces between sentences in comments and doc strings, here and > elsewhere. > > > +(defcustom which-key-idle-delay 1.0 > > + "Delay (in seconds) for which-key buffer to popup. > > +This variable should be set before activating `which-key-mode'. > > + > > +A value of zero might lead to issues, so a non-zero value is > > +recommended > > +(see https://github.com/justbur/emacs-which-key/issues/134)." > > + :group 'which-key > > + :type 'float) > > Please add a :version tag to all defcustom's and defface's. > > > > +(defcustom which-key-idle-secondary-delay nil > > + "Once the which-key buffer shows once for a key sequence reduce > > +the idle time to this amount (in seconds). This makes it possible > > The first sentence of a doc string should be a single complete > sentence. In this case I suggest > > Number of seconds to reduce idle-timer delay after showing which-key on= ce. > > > +(defcustom which-key-min-column-description-width 0 > > + "Every column should at least have this width." > > This needs details, otherwise it's mot very useful. > > > +(defcustom which-key-unicode-correction 3 > > + "Correction for wide unicode characters. > > +Since we measure width in terms of the number of characters, > > +Unicode characters that are wider than ASCII characters throw off > > +the calculation for available width in the which-key buffer. This > > +variable allows you to adjust for the wide unicode characters by > > +artificially reducing the available width in the buffer. > > + > > +The default of 3 means allow for the total extra width > > +contributed by any wide unicode characters to be up to one > > +additional ASCII character in the which-key buffer. Increase this > > +number if you are seeing characters get cutoff on the right side > > +of the which-key popup." > > This seems to be a sub-optimal way of accounting for character widths. > We have better ways, e.g., char-width, string-pixel-width etc. > > > +(defcustom which-key-dont-use-unicode nil > > + "If non-nil, don't use any unicode characters in default setup." > > This should mention the settings affected by it. > > Please go through all the doc strings and make sure they are > sufficiently self-explanatory. > > Thanks.