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#66303: [PATCH] Document 'M-x align' in the Emacs manual Date: Thu, 05 Oct 2023 10:52:06 +0300 Message-ID: <83edi94ic9.fsf@gnu.org> References: <83wmw56md7.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="34888"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 66303@debbugs.gnu.org To: Eshel Yaron Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Oct 05 09:52:55 2023 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 1qoJAF-0008qJ-Fl for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 05 Oct 2023 09:52:55 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qoJA5-0008W1-29; Thu, 05 Oct 2023 03:52:45 -0400 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 1qoJA4-0008Vq-EE for bug-gnu-emacs@gnu.org; Thu, 05 Oct 2023 03:52:44 -0400 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 1qoJA4-0007Q9-6E for bug-gnu-emacs@gnu.org; Thu, 05 Oct 2023 03:52:44 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qoJAM-0005v3-7B for bug-gnu-emacs@gnu.org; Thu, 05 Oct 2023 03:53:02 -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, 05 Oct 2023 07:53:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66303 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 66303-submit@debbugs.gnu.org id=B66303.169649234622706 (code B ref 66303); Thu, 05 Oct 2023 07:53:02 +0000 Original-Received: (at 66303) by debbugs.gnu.org; 5 Oct 2023 07:52:26 +0000 Original-Received: from localhost ([127.0.0.1]:45956 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qoJ9m-0005u9-Bx for submit@debbugs.gnu.org; Thu, 05 Oct 2023 03:52:26 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33142) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qoJ9j-0005tv-EZ for 66303@debbugs.gnu.org; Thu, 05 Oct 2023 03:52:24 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qoJ9L-00061T-W2; Thu, 05 Oct 2023 03:52:00 -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=JAh5E5mnWQ5MhTlnaNDH7kslZgfoQrlyAXojTBssg3E=; b=LfRtZvZFTgAv H6W/r3ynp7XduTt6Rg1kUw1afKGCP2B+sL68wZV0T4PNTlglyXMCDthkl8D3jHlyJSKW7Gyd18941 TH1GAjV+TQ+v+wW0ruGk7GNnDdGpFaipilJGihZPpz7prXVV54x6440y0hPbbzu+5xMnIf7jp/PUq 5cMHw9EutaeSqkn+r35mqMQEU6M3Pt2QWubI9k9WdsVq5T7Z7Xo6BfVAO8plMiYVPN26AZXog+zLV ngh/m/QIOV73+3Jf/cOBOr9lrEVHRw0d/IbJyCjIKZr8+Y+BKnqa187zJfoCOUsTj+Kd3h5FeB7d7 qhezwr+sc9Q8LzRQvcvx3g==; In-Reply-To: (message from Eshel Yaron on Mon, 02 Oct 2023 21:30:59 +0200) 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:271849 Archived-At: > From: Eshel Yaron > Cc: 66303@debbugs.gnu.org > Date: Mon, 02 Oct 2023 21:30:59 +0200 > > > Thanks, but it seems to me we will be better off expanding the doc > > string(s) of the respective functions and variables. The text you > > suggest to add documents one command and 2 user options, and provides > > an example of the usage. I think adding the example to the doc string > > of 'align' and mentioning the two options in its doc string, as well > > as expanding the doc strings of those two options, would give us the > > same benefits without the downsides (extra *.texi file, a larger > > manual, etc.) > > > > WDYT? > > Thanks for taking a look. I think that documenting `M-x align` in the > manual has some benefits that aren't completely covered by enhancing > docstrings. Namely, you can link to the Info from other manuals, such > as manuals of packages that extend/integrate with `align.el`. I also > think it helps with discoverability. (For instance, you can skim the > manual online even without using Emacs.) > > How would you feel about a new section in indent.texi instead of a new > .texi file? That's better. But the text should be more than just mentioning a couple of variables, or else addition to the manual is not justified. The basic question to ask yourself is: are the doc strings in align.el enough to allow users to use this feature, or will they need some "glue" and auxiliary explanations that provide a clearer picture? If the latter is needed, that's the stuff to put in the manual.