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#67499: [PATCH] Add use cases of (fn) documentation facility. Date: Wed, 29 Nov 2023 16:42:42 +0200 Message-ID: <834jh47h99.fsf@gnu.org> References: <87il5mai0x.fsf@jeremybryant.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1257"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 67499@debbugs.gnu.org To: Jeremy Bryant Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Nov 29 15:44:54 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 1r8Lo3-000AVh-M9 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 29 Nov 2023 15:44:51 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r8Lno-0002d4-QZ; Wed, 29 Nov 2023 09:44:37 -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 1r8LnW-0002a9-TZ for bug-gnu-emacs@gnu.org; Wed, 29 Nov 2023 09:44:22 -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 1r8Ln8-0005Gk-SZ for bug-gnu-emacs@gnu.org; Wed, 29 Nov 2023 09:44:07 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r8LnF-00030C-Vk for bug-gnu-emacs@gnu.org; Wed, 29 Nov 2023 09:44:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 29 Nov 2023 14:44:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 67499 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 67499-submit@debbugs.gnu.org id=B67499.170126898911463 (code B ref 67499); Wed, 29 Nov 2023 14:44:01 +0000 Original-Received: (at 67499) by debbugs.gnu.org; 29 Nov 2023 14:43:09 +0000 Original-Received: from localhost ([127.0.0.1]:49267 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r8LmO-0002yo-LE for submit@debbugs.gnu.org; Wed, 29 Nov 2023 09:43:08 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59110) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r8LmM-0002yJ-9g for 67499@debbugs.gnu.org; Wed, 29 Nov 2023 09:43:06 -0500 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 1r8Lm8-00051c-Q2; Wed, 29 Nov 2023 09:42:52 -0500 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=NjI6MGSAJxzUtxFECzrNaEbKN5THomlVHKtJFTGP7uU=; b=n55CDsm5oONg T6pA0t1gPEHHC+chxKrvhmgh9COTGoEhfj91nA96H41u2QeHEH8jMzaw/SC9FCRQdpfMT/6UawJ6m CpndsVZP/KGlr31iLrhOcWV4Sa8t0HG3zbeaftoqAZn/EqS4iON3BUH7kB1c/iJf/JY0WgFSZ4w4N pEQ6lAzdLk3W+3EbkfUzSTcQL5QVyoX0eFW1TBby7wkWl9IgO0hpdEkb4dB/pNed6yymeAJhIWyW1 7O1D9Gvzee0nB04kR0ppDkHYwc2WV5lcRb60ETeHn/yNvBYl31C7BOSsMhA30rrhRGvv1/sOK5Ojf /BkjDwpSqT0V4B7GDS4EuQ==; In-Reply-To: <87il5mai0x.fsf@jeremybryant.net> (bug-gnu-emacs@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:275238 Archived-At: > Date: Mon, 27 Nov 2023 23:30:33 +0000 > From: Jeremy Bryant via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > I have written a proposed addition to the Elisp manual. In now-closed > bug 66928, there was a discussion related to the use of \(fn) in doc > strings, and I have drafted some examples to explain how this facility > could be used. The addition is presented as @ifnottex... in order to > reduce the cost of the printed manual. > > Feedback welcome on draft before I refine further, on conventions, section of > manual, style etc. Thanks. I wonder whether we need this to be said in so many words. Can't we instead just enumerate the uses, describing each one in a couple of sentences, and format that as, say, an @itemize'd list? IOW, do we really need to show an explicit example for each use? Examples are useful when an example is worth a thousand words, which is not the case here, I think. A minor stylistic comments: > +In subr.el, the definition of lambda is as below, and the (fn) facility ^^^^^^^ ^^^^^^ File names should have the @file markup, and symbols and other code fragments (like "&rest" and "defun") should have the @code markup.