From unknown Sun Jun 15 01:03:55 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#72405 <72405@debbugs.gnu.org> To: bug#72405 <72405@debbugs.gnu.org> Subject: Status: 29.4; Doc string of `org-indent-mode' Reply-To: bug#72405 <72405@debbugs.gnu.org> Date: Sun, 15 Jun 2025 08:03:55 +0000 retitle 72405 29.4; Doc string of `org-indent-mode' reassign 72405 emacs submitter 72405 Drew Adams severity 72405 minor thanks From debbugs-submit-bounces@debbugs.gnu.org Wed Jul 31 16:24:25 2024 Received: (at submit) by debbugs.gnu.org; 31 Jul 2024 20:24:25 +0000 Received: from localhost ([127.0.0.1]:50344 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZFs1-0002jB-57 for submit@debbugs.gnu.org; Wed, 31 Jul 2024 16:24:25 -0400 Received: from lists.gnu.org ([209.51.188.17]:35128) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZFry-0002j2-Mr for submit@debbugs.gnu.org; Wed, 31 Jul 2024 16:24:24 -0400 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 1sZFri-000177-CI for bug-gnu-emacs@gnu.org; Wed, 31 Jul 2024 16:24:06 -0400 Received: from mx0b-00069f02.pphosted.com ([205.220.177.32]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sZFrg-0001Nv-FW for bug-gnu-emacs@gnu.org; Wed, 31 Jul 2024 16:24:06 -0400 Received: from pps.filterd (m0246632.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.18.1.2/8.18.1.2) with ESMTP id 46VHu8j5027185 for ; Wed, 31 Jul 2024 20:24:01 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h= from:to:subject:date:message-id:content-type :content-transfer-encoding:mime-version; s=corp-2023-11-20; bh=2 /NcOa2wCMN55+Yf86+QxmDl2z8j/KmbiJlFSfZAbGE=; b=RCD3jFOQushxZ1Y/M o0ZiUm6/vbhKBQl960uUf4AELkKKUDl9mGxowKSt8RL6zzWpTpMlxryqKdsp1oqn KN+eFncvFb3Qsx9wXHY99ZVGlxmmnwg2Qh5tSudRqzBltNzY1oD2WA/IjFCSZSA+ sYc5grTOkf1KrH2cAmk90fk1vMVvDKzCaGWDeM6bkMfxlBBDhRG1wPIYYjTmxFQn an5PEpbuAcf3scxiud3eoqA+p9dAkV9Wg/WeWckS70XOWCVm4ogyDFIUm0V52uIo gSJRutHF3YYZlfUs2imSIBljMamUF1/+i/qUb5vMFl8zqd/rxuULy6o2rvRMQ7cV TAqug== Received: from iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta03.appoci.oracle.com [130.35.103.27]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 40mrgs8ah8-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 31 Jul 2024 20:24:01 +0000 (GMT) Received: from pps.filterd (iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 46VK8UBW019182 for ; Wed, 31 Jul 2024 20:24:00 GMT Received: from nam11-bn8-obe.outbound.protection.outlook.com (mail-bn8nam11lp2174.outbound.protection.outlook.com [104.47.58.174]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTPS id 40qjmsracu-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 31 Jul 2024 20:24:00 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=gvZrMrvgaKBef7xV+Qc333jITppjFSybA1SIM4jNkjbVE7waxMP+PNXfZtEMT67xMcLuXtf5/DBCtDAI793kHdTdfX0K/oPX7iPvyD8PY9ujf1PlzBAxBYo62gMf0RcJkvZTIAx4rPMG1eFBQGFOA+VKq+nBIPVqMJC/8amQeFLsAENoZxTcw5iEFY3Hbc36QCVaQdpFes+rrjVNuZo4Oc3yjWJgunAQ4gfa6XfwsyD1fVy1kBWP4zVxek9d9UHJpW+fcXWhLLp7U784CwYS0xd5c7mgWgZZ3rS9bRx7v8gWfNLRrhAMb0DazolKM2gFihnxYlid0KZfH0Gc1L3hsQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=2/NcOa2wCMN55+Yf86+QxmDl2z8j/KmbiJlFSfZAbGE=; b=ndfZVVeuODIsQ2l4lO5nw1L8EfceiRMc22J3iLJ8hVF8imFYiQB0IkrGW3cSFiYI24Aai4o3BWbEo+r5juBnsVyUeiI0DsMTUpO0YoRhg05IyIa4sePkS5WBYOrC1xHJ00KeblviFZI2CyuKcU6Bqsm7M1ISP9dYC2+1x7Fdtn6FZmqIx7++Tj7Rrjb+yqscHZXpvS+5ifzviAbKUwtWq7Oa8zvMozQWucXbqmH+hHTjc86etkSNJac7yHH6oau0bEGAIRX2qCEG7rKer4tQdO4tgtGMtfL8vJmBRsYV1ewUe8TYpIkz90OTVlZ+5CzAwBrz5UlkNcmE1sElNgl7+Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oracle.com; dmarc=pass action=none header.from=oracle.com; dkim=pass header.d=oracle.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.onmicrosoft.com; s=selector2-oracle-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=2/NcOa2wCMN55+Yf86+QxmDl2z8j/KmbiJlFSfZAbGE=; b=TgVMOPwF7x/qZhFKF1ol8rPhwNYPT2Er3sA8tX/cxWUxWZNmzS7BIzpTa7VmN6xQ9WyjAtIsN5iDUeVgypi2nfUpINAqjvtfTh9SKkypufryZiOPzveNwlwfBHALG2aZZeqbNlJSSuvDIcdUeAxlYTv9ASWiAUzxBbdG+DTnYzc= Received: from DS7PR10MB5232.namprd10.prod.outlook.com (2603:10b6:5:3aa::24) by CH2PR10MB4278.namprd10.prod.outlook.com (2603:10b6:610:7f::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7828.22; Wed, 31 Jul 2024 20:23:59 +0000 Received: from DS7PR10MB5232.namprd10.prod.outlook.com ([fe80::8303:658f:14f8:2324]) by DS7PR10MB5232.namprd10.prod.outlook.com ([fe80::8303:658f:14f8:2324%7]) with mapi id 15.20.7828.016; Wed, 31 Jul 2024 20:23:59 +0000 From: Drew Adams To: "bug-gnu-emacs@gnu.org" Subject: 29.4; Doc string of `org-indent-mode' Thread-Topic: 29.4; Doc string of `org-indent-mode' Thread-Index: Adrjh2MtZ01WAVZBT+SNBYTwNFoijQ== Date: Wed, 31 Jul 2024 20:23:59 +0000 Message-ID: Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: DS7PR10MB5232:EE_|CH2PR10MB4278:EE_ x-ms-office365-filtering-correlation-id: d5e9abb9-ffbd-4b37-6509-08dcb19eb5ba x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; ARA:13230040|376014|366016|1800799024|38070700018; x-microsoft-antispam-message-info: =?us-ascii?Q?qHCXnBYCT45iVKPE+CD4kCMuk+Mh2PEOaZ6EzOC0u7hdXbF+16wZivvEYFJM?= =?us-ascii?Q?3mTVrFUpz4X/pfp9TUEGVjZI6cYTpArbtdkoPUateGlznsJwHXujn58IjGQE?= =?us-ascii?Q?f1rEs92g2noRRdKaWL6yDsDIyyg5AjCwmVv1epQfhG2uU2KqGcpmAHNg1kJc?= =?us-ascii?Q?1xFPPDNpqK0pt4jZTyKBtSd4x5/qUY/94pAGO0c/DcKrpB0zSkBCqRUllzn0?= =?us-ascii?Q?kvUUIg5TQG+8ySKl9fnTSG4ds33Ia9MX0Fc3nvS0VEQ6qc6FtIn6KieRortx?= =?us-ascii?Q?0oPxt18h21Gf2FNqn5ZRmEfiuS+E1hsNsZ3etJuOiunpPyTr/0UeCmeWVEoL?= =?us-ascii?Q?KX4HfPctF3ZbozTDTVTNFLBJpleGjtvf/LblZvmNIGW01TzBKgunUYuV51EC?= =?us-ascii?Q?rhV2Gk3Blu0e2AtgSQHUBgS8e4F4T/dmZHfewwTIFwYyN04oy33FZEn/HX3w?= =?us-ascii?Q?vCPOTrJsrHQ/4ylWw47QJ8DWhE561C4M+qJD4QBwUONjKXCusMWlpS4Y9sNk?= =?us-ascii?Q?lIvOvMV/wlvpx4b750A7u7QHjbd2jf5XKfWCZoOtnrTxtbVC5RDenwVn3afg?= =?us-ascii?Q?xmPablBuOT5H1YZ5bOA3vkW3fdpY+kzPvXPS78WJtQSX6XOgiIXzPoA2zN9y?= =?us-ascii?Q?RlYPcv5V8NAQmrT7WpSDmRw4LpMJkHoPcTrBt/dAeBHGPGh2h7Jx1Oc0yGmC?= =?us-ascii?Q?RwTAi1A9oyMvLcayrA9rZfhTSJBr2KZRESWaMtzBxp+sq1/PogPzckBQRXfi?= =?us-ascii?Q?GRD7rgd3tIs00p7DY/RkZZh3VcDsdg1dz2KllpTVlAw33vpiJP61NCe2r4f5?= =?us-ascii?Q?THVUxfhMMHNvkBOJj3sV3rFxGDZHGzc0Ruu2t7ybnREm5n0oEkdK487/6zbN?= =?us-ascii?Q?0Y3YYjUITNniFpMNqnZar7nCllYdjE7nCxWKs2jXzuUOXU+BBxTjM4pnyAj8?= =?us-ascii?Q?NKY8tCafLJ07XLqeMTiN+mW3GdRBw/CcllMhnqm3ynvy2nRARPEXfrweouWn?= =?us-ascii?Q?ZHrrYf5GULhaVlkKzTMw1hnaoNl1xXMv+pn0O3wWR6xYaULOWIoyrueMYTvf?= =?us-ascii?Q?6JEJeAayEvM+zZh3v1FsxtIxjs3G5VzjKhzqBR+tgPZbktLqQ2ASKhs/bt0f?= =?us-ascii?Q?Wi4Wx6Ka6op0E4qUa29p2dMFmD07vpGzhCNf/iiLPFlDrh4CQygogJGEkNlv?= =?us-ascii?Q?Fkwx3txZfaMSmhWt1Eab/VndIYFV3AMiTA1GsBqZWta0R0pSrT8ylPoYg7i8?= =?us-ascii?Q?29mdLDCrXaYfmqMbrr2tXs5oB/dr3OuNha1Fnc9N2VFjM4Dzb0I1+0uXzvTK?= =?us-ascii?Q?Nbv63iAH4FHer3jsHVWsEbxQpiNvvTAMny5Q+tOw3LFOA1XhqOWoorzCxH4O?= =?us-ascii?Q?oMvllh6Y6mldiNLq0OCdUuf7Xk5w3FWKe4URTCnKG5/LwH9WCg=3D=3D?= x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS7PR10MB5232.namprd10.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(376014)(366016)(1800799024)(38070700018); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?2N/XdvxB1s14ASDwxVLIbrjC9qh5C91+OGyfVfC77nY00Krnh6/LaTNw5o9R?= =?us-ascii?Q?0HXXjJaKebpCI8U7lVKatWpn/loO93OZoGEOxsn1Ws6ELEfBYIa5zByzqVFa?= =?us-ascii?Q?Paak6DwD8ktVTfOhQJV43ouPb/hyvju/qeXFsGsZIqCReMiYE7/c1zKQymWg?= =?us-ascii?Q?QK+w0VCk+swCYKC9pdGtV3EBLFM0ci4F6ia8NbQudCmAP+229kfxGINNJNJv?= =?us-ascii?Q?wMOCvk6U0OT2zQl89L5fI8g8ce4/WYyxmYLOMSeTpR3EM80hE23fTqUHo0gp?= =?us-ascii?Q?IwVowj50LtGFnRnirWsHl+YStJM6HvlYDVJSTsagB0m/ozBwwX1c2MyEqA4p?= =?us-ascii?Q?Xt0DBwA7OlBKHPHYvC9JKxAnm43sffr789buREsysIzeZ66YcviEKZK3a3+k?= =?us-ascii?Q?OmivOI4YlI2YraoatopkQ3iJLtqjxljOy31wLXTw8ghjkvukVXKBo8XUaP8C?= =?us-ascii?Q?ta3NJlWTaxD07rNms5rBzGqk9NNm6XAWGXD/MUbDfg+Z0/YqyLmzQYK1yW4A?= =?us-ascii?Q?4Y/9K37SvSJpfq7JwfgJOLx8YrsSep0+eHtuS6xEMbgOHnukq7e5yrN7XOoD?= =?us-ascii?Q?PohSXrFlf3p9ej9bTPWFiuO1FdGaUDXsRX4CSGlRTrtu6J0jriOQgyhc4BJI?= =?us-ascii?Q?BCRG8Uxv93soPMIoOxiiXy0Ilmv/5Hl3h1AlH128CbLWjDlBFTK6tkwE4Myr?= =?us-ascii?Q?zWAhvrs66N2MN1Ydenzfo9gGDQEdaRxF5WQdgpoBp67NiHGw2tlg4k4mxvfI?= =?us-ascii?Q?UQBANMe3kOF/GsXg5ecFdD401ATtyYEmMsBPdhqIkdejEcwuSP3qMlndee8a?= =?us-ascii?Q?stZhdGCnXOvjVhmOfn8I7E+0jYcNHNkUKAkeixIzf9lr7e8Gn7ufPMHObRqM?= =?us-ascii?Q?lGA/c+LDBV41hQhsxc5q3fiTBgrobkUgEdA2xjndARVMFdP3BZfzMr2nrscA?= =?us-ascii?Q?QGLGAcUy8ZKbxeumEs2wCpNkOb9/ZKnKR33RJaAw5BSX0LpzxodNHOuslu8O?= =?us-ascii?Q?XsYSIPvpJjtQrIC8PpIaFTWx7E2MX3vTWKhpOtiI9FjGCvV+7tm0uewwLcvt?= =?us-ascii?Q?Fk5Zs4EWv2bwW5NHWpGW+7y4ZgAU0E1BN4BYp162tIKo2qAayOWIM05gegVd?= =?us-ascii?Q?abf9tgA5cHNl3zYPQEAbQHcDLqUUcDHrU2zN3r8MXdaQptAoUJvsEpqdEiSH?= =?us-ascii?Q?0yV0uhS1uhQWxYJ7cMlcHP9ge9BSgdbRoidQM56xXOY1NUQ/QAKpiFE4CkjM?= =?us-ascii?Q?RYGJtrFU/e0RRFeGzWrBDa95YvwsH2sHbZh/DKzaKnqKcrADk4as3B/VtsQg?= =?us-ascii?Q?a5RlEBoiXS0lDxIrdEVjhhKwkueDdS+USCBbsnJ528qRulsgHnUZQ/gIaJwQ?= =?us-ascii?Q?IhekMfaVpdTCbBrJLDBIScfxtO58L9hXZF7f8d0ERcQvhWIAlHLuTg/SwoGm?= =?us-ascii?Q?+0pXj7nO5P/yVOhzU7sFW08aAelrv4Uz9iBc2s45D72Cv4xHpawnuEqV+gmd?= =?us-ascii?Q?b+QJx7XIwovgW8rp7Mmue/mnsfHp+7UvXqdGG6mdALTK5eMpje/h7WFDd9Bl?= =?us-ascii?Q?2kNf08hzDW2gw4qHGg2YfmSGH0cnwnQFRGLWU5ob?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: s/y/bGiM513pKxAgWg24F+asy9D9E9w2b6ZJLqqgG5x+/DFkjiFeXC+CV/Vyvo0RLxtaXCTACXuubQiK7agvpcxH2eTovKyy6WZSMv3JezrqmuEgKHt1JMOETOv3XT2vqFUc4HM3WyY999oxnFMRFeUPOly0ybHd5mUY4M/4keAvjujG8QVCTsKhe8kSnaXprnMdGxqqA38lWQgLSy8awbVHnxxqJ0w/vIQlN23wU7BNIF2jNL8CrtUQK+zAwU6f3/6T/2Ko16G42dDA55wZcZ4vQOOCdr2gaSEeR3hpD3yOA2gSDxDylwe03Qr/azZSyQhbRs7nKOfOt/wp5Tn/bHmJp+IFAck2J1ZBtGmCkf/kkvTZu1jHhI/G4kXpwtT5LY99jkU2uT92rDVTak7P2DYpllMIqs0oGKBn2JLsjjyOfJRHnTrNo3LemD2ll5tBPme6RZSzzt6UepIPx5RikMelR4J8BHAxDab1v5uIJylO9Z1aUPsf08C2yTO58BAbbOB0MrGsfrHTw+nWElODdOSM+feGczlSoZK03F0MxJncOLOy3Ese7YeEXcEMztNHU7LL+ITz9IMHRpA1prbcHh4N5QrgeWczU78a8OVmzEQ= X-OriginatorOrg: oracle.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DS7PR10MB5232.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: d5e9abb9-ffbd-4b37-6509-08dcb19eb5ba X-MS-Exchange-CrossTenant-originalarrivaltime: 31 Jul 2024 20:23:59.1298 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: DTrudkjVM3WS2LI7Jj/FFf9Md2JFIcy/UU0W8ZAcj/qZ5m88F8rxHwIlCEvlO52RmgW4ctPzKOgz0fHUVEoddQ== X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH2PR10MB4278 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1039,Hydra:6.0.680,FMLib:17.12.28.16 definitions=2024-07-31_10,2024-07-31_01,2024-05-17_01 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 malwarescore=0 suspectscore=0 mlxlogscore=999 phishscore=0 spamscore=0 mlxscore=0 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2407110000 definitions=main-2407310143 X-Proofpoint-GUID: mP7pkCtuyvMG5Q-rwZJBG4EgAGtA2VsG X-Proofpoint-ORIG-GUID: mP7pkCtuyvMG5Q-rwZJBG4EgAGtA2VsG Received-SPF: pass client-ip=205.220.177.32; envelope-from=drew.adams@oracle.com; helo=mx0b-00069f02.pphosted.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.3 (-) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) Likely applies also to other minor-mode doc strings. emacs -Q C-h f org-indent-mode ____ That shows you doc that includes this, where `org-indent-mode' is a link intended to give you information about the _variable_ of that name: To check whether the minor mode is enabled in the current buffer, evaluate 'org-indent-mode'. Clicking that link doesn't take you to the _variable_ part of the *Help* buffer; it just puts you back at the start of the buffer (after redrawing it uselessly). It should take you to the description of the variable. And the sentence should include the word "variable" before `org-indent-mode'; otherwise, it makes little sense to speak of evaluating that symbol, and the text can confuse or mislead users. In GNU Emacs 29.4 (build 2, x86_64-w64-mingw32) of 2024-07-05 built on AVALON Windowing system distributor 'Microsoft Corp.', version 10.0.19045 System Description: Microsoft Windows 10 Pro (v10.0.2009.19045.4651) Configured using: 'configure --with-modules --without-dbus --with-native-compilation=3Daot --without-compress-install --with-sqlite3 --with-tree-sitter CFLAGS=3D-O2' Configured features: ACL GIF GMP GNUTLS HARFBUZZ JPEG JSON LCMS2 LIBXML2 MODULES NATIVE_COMP NOTIFY W32NOTIFY PDUMPER PNG RSVG SOUND SQLITE3 THREADS TIFF TOOLKIT_SCROLL_BARS TREE_SITTER WEBP XPM ZLIB (NATIVE_COMP present but libgccjit not available) Important settings: value of $LANG: ENU locale-coding-system: cp1252 From debbugs-submit-bounces@debbugs.gnu.org Thu Aug 01 01:06:13 2024 Received: (at 72405) by debbugs.gnu.org; 1 Aug 2024 05:06:13 +0000 Received: from localhost ([127.0.0.1]:50667 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZO0y-0007X4-QU for submit@debbugs.gnu.org; Thu, 01 Aug 2024 01:06:13 -0400 Received: from eggs.gnu.org ([209.51.188.92]:51954) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZO0x-0007Ws-5E for 72405@debbugs.gnu.org; Thu, 01 Aug 2024 01:06:12 -0400 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 1sZNyV-0001hA-AK; Thu, 01 Aug 2024 01:03:39 -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=XbhZ/ZZn0RjeYEAOIXXZXzdKxYMeglEpsogFW03sN6Q=; b=KFRMn9HUPcyD 4vLBFxKqT/oYuBMt7oGLvJJxH2M8URcDBS4BtwE/zjvNb9a5SoXbap0HpIdgWwzYTbP3IJ0P9vdcH jqfT8y8VQOJ1Nw3hVl9GFu42uSkhxdagmZE3nJlVaFhYUGFk4M4WV4jtNntjTdarJqCF37Y0Vdk8Y AdFbosgCmRWNNfxE2rSBbsqQt6UQ5+9GPu28T0EBC2ZjaBDs7GHWeNFa7vq/O3keK0SFnViotpQY8 b1fKGP+DLX8FbA5o4umhlFAL0Pa4Tiec/FYZj40gyfikduu3J7vG6f3wGIlNZV3c3Tz/aIvWg/35E NaYUHWaVqjahymuBIySYcA==; Date: Thu, 01 Aug 2024 08:03:37 +0300 Message-Id: <86cymsyguu.fsf@gnu.org> From: Eli Zaretskii To: Drew Adams In-Reply-To: (bug-gnu-emacs@gnu.org) Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' References: X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > Date: Wed, 31 Jul 2024 20:23:59 +0000 > From: Drew Adams via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > Likely applies also to other minor-mode doc strings. > > emacs -Q > C-h f org-indent-mode > ____ > > That shows you doc that includes this, where `org-indent-mode' is a link > intended to give you information about the _variable_ of that name: > > To check whether the minor mode is enabled in the current buffer, > evaluate 'org-indent-mode'. > > Clicking that link doesn't take you to the _variable_ part of the *Help* > buffer; it just puts you back at the start of the buffer (after > redrawing it uselessly). > > It should take you to the description of the variable. And the sentence > should include the word "variable" before `org-indent-mode'; otherwise, > it makes little sense to speak of evaluating that symbol, and the text > can confuse or mislead users. Thanks, but please report Org issues to the Org mailing list first. If the Org developers determine it's a core Emacs problem (which is hardly possible in this case, but who knows?), then it should be reported here. From debbugs-submit-bounces@debbugs.gnu.org Thu Aug 01 01:42:28 2024 Received: (at 72405) by debbugs.gnu.org; 1 Aug 2024 05:42:28 +0000 Received: from localhost ([127.0.0.1]:50682 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZOa3-0000GH-Rd for submit@debbugs.gnu.org; Thu, 01 Aug 2024 01:42:28 -0400 Received: from mail-pg1-f194.google.com ([209.85.215.194]:52468) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZOa1-0000Fz-SI for 72405@debbugs.gnu.org; Thu, 01 Aug 2024 01:42:26 -0400 Received: by mail-pg1-f194.google.com with SMTP id 41be03b00d2f7-7a115c427f1so4120288a12.0 for <72405@debbugs.gnu.org>; Wed, 31 Jul 2024 22:42:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1722490863; x=1723095663; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=k8TvtbC4MngUjXhz2rZJcM3CEEPbGVLrMYJARYzDz6o=; b=MbtjevgREu+drWmMZecrDcrxlRVeqLISZT9fWq/BhfHdLkQGFc/9kiZeY/B00BVFTK mQqeBjzjMzgCp0r2EzcwJGMVMSaylv6lCJ943N+cY8MiHpqfWX33tZriSWJCx9pMtK/L ewYD775SzeeHTxF8Nh+N/tRKPKnlMH+4xljFesQMYqn1YsF3ywD5YwuG44DhGYX3TsVr dHt3wZxsPcBy5NMlet9xb5myi2o0yiAAx1K/zf2d7XW/s+w5woqnMmjyMBZFDLzCQ4N9 4gmgdRFvZnn0SwIDURFYQ/9GTLTVqrfB1FtNyfE+4wc9+pV3dBgYwKZQLCRNXeMKjBM0 l/fQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1722490863; x=1723095663; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=k8TvtbC4MngUjXhz2rZJcM3CEEPbGVLrMYJARYzDz6o=; b=OTQGnSGw5Budtqt6al2wmRVAUAuP1Na3HRxkluCa/4rHV5vCCZyOabmqdjm8a5HXQS V2630Q7RJtmA7C+44KF24e9Q7eRYcjgwg9uB84G1sJm/I2x319GqO7vk+P3VGTiSfwSP PYh2D6CjXlp5ToQStE5MO/BO8WsO7cYyDxuPXK56ectoeA7Hrw++3acFRnodJcWesAT2 Am4zNTb7BsnpVD96Wr9rtMwZW9v0Wlts6ESi6zMR2b4sK6XvqdMu+RrAR3M1qildMCx/ 9hWQGhhSZCXd+hPyNpy8mFEbsdcYCtDd5DddG/Tbp4ox4delvd3MnegylFelWJ/ZcsML S1BQ== X-Forwarded-Encrypted: i=1; AJvYcCUhEscEGPKNFrGxdCgZkhTMyL6Ph2udT+iiOJjZBOfuzZ9f6fngVhkahQLrLF9uQt33DYzI3YITSGeRTaeHkEdUpSq3Q/4= X-Gm-Message-State: AOJu0YxhcaBvX9WHFxVC9GwTlx0GQ2eUTbyeMdkM4BAAYK460x9yqVxX N+N5P2k/alVO2iBvBFJyzXVvqD/A0suWTgy/6OmtnHw8Po2FLq0Q X-Google-Smtp-Source: AGHT+IENcjbnY7HgQKBtAK038uBWc74AAud55S8klpel3mLVVEeSmC6JVwGuNS+FNT2mixD6lY67Nw== X-Received: by 2002:a05:6a21:3297:b0:1c0:f193:8387 with SMTP id adf61e73a8af0-1c68ce79b75mr2200936637.11.1722490863412; Wed, 31 Jul 2024 22:41:03 -0700 (PDT) Received: from localhost ([49.204.137.179]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-1fed7eebbe8sm129371415ad.152.2024.07.31.22.41.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jul 2024 22:41:02 -0700 (PDT) From: Visuwesh To: Eli Zaretskii Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: <86cymsyguu.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 01 Aug 2024 08:03:37 +0300") References: <86cymsyguu.fsf@gnu.org> Date: Thu, 01 Aug 2024 11:10:43 +0530 Message-ID: <877cd0iyw4.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, Drew Adams X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) [=E0=AE=B5=E0=AE=BF=E0=AE=AF=E0=AE=BE=E0=AE=B4=E0=AE=A9=E0=AF=8D =E0=AE=86= =E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 01, 2024] Eli Zaretskii wrote: >> Date: Wed, 31 Jul 2024 20:23:59 +0000 >> From: Drew Adams via "Bug reports for GNU Emacs, >> the Swiss army knife of text editors" >>=20 >> Likely applies also to other minor-mode doc strings. >>=20 >> emacs -Q >> C-h f org-indent-mode >> ____ >>=20 >> That shows you doc that includes this, where `org-indent-mode' is a link >> intended to give you information about the _variable_ of that name: >>=20 >> To check whether the minor mode is enabled in the current buffer, >> evaluate 'org-indent-mode'. >>=20 >> Clicking that link doesn't take you to the _variable_ part of the *Help* >> buffer; it just puts you back at the start of the buffer (after >> redrawing it uselessly). >>=20 >> It should take you to the description of the variable. And the sentence >> should include the word "variable" before `org-indent-mode'; otherwise, >> it makes little sense to speak of evaluating that symbol, and the text >> can confuse or mislead users. > > Thanks, but please report Org issues to the Org mailing list first. > If the Org developers determine it's a core Emacs problem (which is > hardly possible in this case, but who knows?), then it should be > reported here. That sentence is part of easy-mmode--arg-docstring that gets added to all the minor-mode docstrings. So it is not org-mode specific. For example, font-lock-mode also has the following text: To check whether the minor mode is enabled in the current buffer, evaluate =E2=80=98font-lock-mode=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Thu Aug 01 02:00:40 2024 Received: (at 72405) by debbugs.gnu.org; 1 Aug 2024 06:00:41 +0000 Received: from localhost ([127.0.0.1]:50694 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZOrg-0000jw-FI for submit@debbugs.gnu.org; Thu, 01 Aug 2024 02:00:40 -0400 Received: from mail-pl1-f195.google.com ([209.85.214.195]:47104) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZOrd-0000jj-UU for 72405@debbugs.gnu.org; Thu, 01 Aug 2024 02:00:38 -0400 Received: by mail-pl1-f195.google.com with SMTP id d9443c01a7336-1fd66cddd07so47925435ad.2 for <72405@debbugs.gnu.org>; Wed, 31 Jul 2024 23:00:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1722491955; x=1723096755; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=vNtPggYc7CAUQ93KQ/k0sr9uiE6LKPl+iGjL6heo7Ic=; b=KpaUPQZ3r0bq/Gc5c9mx/QDQygfsmgmcXyP+PeV9RX/EZF7kiWYaUDy18Fo9kh7hfv uGXfKcQZ8Xnz8K6hA6eRDFp84HntgMk0MEoeKjcf4cn8Rd1P+9i/lqTuqBHEszM54Gu9 QCRyx2BRRNMSxZV5IbzcBxhZuL+nzrrro7WEOrUHJ5aG7TzxymVxCN29GTihQGNznJgx I8M5W58rmmE9xARL7VyoECva+gU8tmrJWy8gDoCKihLrY0aZJRB1hJgKQ/MIwiNUUY8+ t9cBQ4B6bBtjntP0araGtGjhNwUsOn3zm2yvU3FpLJCxI1qC9hraTAHFdOJntHdEw6hO H0Rw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1722491955; x=1723096755; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=vNtPggYc7CAUQ93KQ/k0sr9uiE6LKPl+iGjL6heo7Ic=; b=TnfGjXbL+WWrj6588MHlQUs2dLjFYXiEBss1q/rRMWtOWlToCFL9c3AN2mvDM56cs3 UDv9UqWeT2rwr/DmT9xwdeWFo6nPw9LkxR402/H4mTIHiJ4IuD91LCQNdeqk5ySM21Tw Pm/X3zCBVmP+pJwSlB84gkBKEBq7eiWB0BNMBvzo8Ds9exblbiXV+TISqs64B3Df6Yx9 czI6UVyrB/q+0fR3ghEp2wVCTqH0EJbl5Ntvad3GEnn3NJCoV1ecGGwYs+WMbcjJ9/e3 Vy3f6J7Ee+inBUfwASRrypImNCMs//3AN+3GFjPVgz++L8PUtxBU5zAscYadM/pBrt75 b87Q== X-Gm-Message-State: AOJu0Yy5eoViHrw1vHfhos7EcFvRTj+xG8bUY+jRHbQ5iTcL7dHwlLwe /FRtGMZCtxXn/6IrSk+nlMNho+wbgH4zSrmcae0jom062LxhV1fHTvfaDY5J X-Google-Smtp-Source: AGHT+IE/D3+9+/PA6lgXOengfMK5HuKwpWdQHww1ljJePk0NuHUTMwgBTzg19jrR6WgY3fZyw6gyfw== X-Received: by 2002:a17:903:120e:b0:1fc:55ab:8760 with SMTP id d9443c01a7336-1ff4cea7175mr15212695ad.27.1722491955420; Wed, 31 Jul 2024 22:59:15 -0700 (PDT) Received: from localhost ([49.204.137.179]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-1fed7f1b7dfsm129653235ad.189.2024.07.31.22.59.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jul 2024 22:59:15 -0700 (PDT) From: Visuwesh To: Eli Zaretskii Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: <877cd0iyw4.fsf@gmail.com> (Visuwesh's message of "Thu, 01 Aug 2024 11:10:43 +0530") References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> Date: Thu, 01 Aug 2024 11:29:12 +0530 Message-ID: <8734noiy1b.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, Drew Adams X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) [=E0=AE=B5=E0=AE=BF=E0=AE=AF=E0=AE=BE=E0=AE=B4=E0=AE=A9=E0=AF=8D =E0=AE=86= =E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 01, 2024] Visuwesh wrote: > [=E0=AE=B5=E0=AE=BF=E0=AE=AF=E0=AE=BE=E0=AE=B4=E0=AE=A9=E0=AF=8D =E0=AE= =86=E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 01, 2024] Eli Zaretskii wr= ote: > >>> Date: Wed, 31 Jul 2024 20:23:59 +0000 >>> From: Drew Adams via "Bug reports for GNU Emacs, >>> the Swiss army knife of text editors" >>>=20 >>> Likely applies also to other minor-mode doc strings. >>>=20 >>> emacs -Q >>> C-h f org-indent-mode >>> ____ >>>=20 >>> That shows you doc that includes this, where `org-indent-mode' is a link >>> intended to give you information about the _variable_ of that name: >>>=20 >>> To check whether the minor mode is enabled in the current buffer, >>> evaluate 'org-indent-mode'. >>>=20 >>> Clicking that link doesn't take you to the _variable_ part of the *Help* >>> buffer; it just puts you back at the start of the buffer (after >>> redrawing it uselessly). >>>=20 >>> It should take you to the description of the variable. And the sentence >>> should include the word "variable" before `org-indent-mode'; otherwise, >>> it makes little sense to speak of evaluating that symbol, and the text >>> can confuse or mislead users. >> >> Thanks, but please report Org issues to the Org mailing list first. >> If the Org developers determine it's a core Emacs problem (which is >> hardly possible in this case, but who knows?), then it should be >> reported here. > > That sentence is part of easy-mmode--arg-docstring that gets added to > all the minor-mode docstrings. So it is not org-mode specific. For > example, font-lock-mode also has the following text: > > To check whether the minor mode is enabled in the current buffer, > evaluate =E2=80=98font-lock-mode=E2=80=99. Here's a patch to make it insert "the variable " after evaluate. But I'm not sure if (symbolp getter) will catch all non-variable cases. AFAIU, GETTER can be any generalised variable. diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index ba0f8bad393..2262fb8ed5b 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ easy-mmode--arg-docstring Disable the mode if ARG is a negative number. =20 To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s`%s'. =20 The mode's hook is called both when the mode is enabled and when it is disabled.") @@ -128,6 +128,7 @@ easy-mmode--mode-docstring easy-mmode--arg-docstring (if global "global " "") mode-pretty-name + (if (symbolp getter) "the variable " "") ;; Avoid having quotes turn into pretty quotes. (string-replace "'" "\\=3D'" (format "%S" getter))= ))) (let ((start (point))) From debbugs-submit-bounces@debbugs.gnu.org Thu Aug 01 02:18:38 2024 Received: (at 72405) by debbugs.gnu.org; 1 Aug 2024 06:18:38 +0000 Received: from localhost ([127.0.0.1]:50705 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZP93-0001Ag-UM for submit@debbugs.gnu.org; Thu, 01 Aug 2024 02:18:38 -0400 Received: from eggs.gnu.org ([209.51.188.92]:32842) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZP92-0001AT-Ee for 72405@debbugs.gnu.org; Thu, 01 Aug 2024 02:18:36 -0400 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 1sZP8f-0007kZ-AD; Thu, 01 Aug 2024 02:18:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=MnBEdwfMqdasdkQmMrlBsQJQnH0zkxeI1i1T4n3B5hw=; b=bxUGlgF8VU+KSMvs5hPP ZU3SJOc56HdxQbeGKUUxMIFauORyCLUhcxx1OLLEhfB5/XWCwKAaqFjA2nJ+tIxZhGMWhlV6RVE9f BneqasgTpBougdIdi05qjh0T5OHOjYC2eybyTZv19YXyqQ8uxPWLpQNZehE/a167KtKnzeCCfbeXq weqMpDoECU99n3VAM7Bx8e4NAGNRligMEExzjInZKp/xrJE4oN+n/R/lGnh1zW1URU5H5cPM03bOE 8gp1Q8EfwOQ1VH2SVx0nf8E0MIXu3C2k1mVl8rN7GwOiyhlDjHMqwmh1rPlaGak1l5UFlI2cCILSF LX1B78y7nq/Wyg==; Date: Thu, 01 Aug 2024 09:18:11 +0300 Message-Id: <86zfpwwyu4.fsf@gnu.org> From: Eli Zaretskii To: Visuwesh , Stefan Monnier In-Reply-To: <8734noiy1b.fsf@gmail.com> (message from Visuwesh on Thu, 01 Aug 2024 11:29:12 +0530) Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Visuwesh > Cc: 72405@debbugs.gnu.org, Drew Adams > Date: Thu, 01 Aug 2024 11:29:12 +0530 > > [வியாழன் ஆகஸ்ட் 01, 2024] Visuwesh wrote: > > > [வியாழன் ஆகஸ்ட் 01, 2024] Eli Zaretskii wrote: > > > >>> Date: Wed, 31 Jul 2024 20:23:59 +0000 > >>> From: Drew Adams via "Bug reports for GNU Emacs, > >>> the Swiss army knife of text editors" > >>> > >>> Likely applies also to other minor-mode doc strings. > >>> > >>> emacs -Q > >>> C-h f org-indent-mode > >>> ____ > >>> > >>> That shows you doc that includes this, where `org-indent-mode' is a link > >>> intended to give you information about the _variable_ of that name: > >>> > >>> To check whether the minor mode is enabled in the current buffer, > >>> evaluate 'org-indent-mode'. > >>> > >>> Clicking that link doesn't take you to the _variable_ part of the *Help* > >>> buffer; it just puts you back at the start of the buffer (after > >>> redrawing it uselessly). > >>> > >>> It should take you to the description of the variable. And the sentence > >>> should include the word "variable" before `org-indent-mode'; otherwise, > >>> it makes little sense to speak of evaluating that symbol, and the text > >>> can confuse or mislead users. > >> > >> Thanks, but please report Org issues to the Org mailing list first. > >> If the Org developers determine it's a core Emacs problem (which is > >> hardly possible in this case, but who knows?), then it should be > >> reported here. > > > > That sentence is part of easy-mmode--arg-docstring that gets added to > > all the minor-mode docstrings. So it is not org-mode specific. For > > example, font-lock-mode also has the following text: > > > > To check whether the minor mode is enabled in the current buffer, > > evaluate ‘font-lock-mode’. > > Here's a patch to make it insert "the variable " after evaluate. But > I'm not sure if (symbolp getter) will catch all non-variable cases. > AFAIU, GETTER can be any generalised variable. > > diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el > index ba0f8bad393..2262fb8ed5b 100644 > --- a/lisp/emacs-lisp/easy-mmode.el > +++ b/lisp/emacs-lisp/easy-mmode.el > @@ -91,7 +91,7 @@ easy-mmode--arg-docstring > Disable the mode if ARG is a negative number. > > To check whether the minor mode is enabled in the current buffer, > -evaluate `%s'. > +evaluate %s`%s'. > > The mode's hook is called both when the mode is enabled and when > it is disabled.") > @@ -128,6 +128,7 @@ easy-mmode--mode-docstring > easy-mmode--arg-docstring > (if global "global " "") > mode-pretty-name > + (if (symbolp getter) "the variable " "") > ;; Avoid having quotes turn into pretty quotes. > (string-replace "'" "\\='" (format "%S" getter))))) > (let ((start (point))) Stefan, any comments to this suggestion? From debbugs-submit-bounces@debbugs.gnu.org Tue Aug 13 20:40:48 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 00:40:48 +0000 Received: from localhost ([127.0.0.1]:45727 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se24G-0008S5-CT for submit@debbugs.gnu.org; Tue, 13 Aug 2024 20:40:48 -0400 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:28655) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se24E-0008Ri-0G for 72405@debbugs.gnu.org; Tue, 13 Aug 2024 20:40:46 -0400 Received: from pmg1.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id 4525C100061; Tue, 13 Aug 2024 20:40:06 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1723596005; bh=ThgJvh+P1mJn7z5y3JPFOrYEuFLglWiMmNgTODF4DGg=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=C3XLRGGQJL6cQegUTtW5nS0lc2HAtmKxr8w0Nb0FMNUCJvaEWMxsyu2i9yg0cICcm w3OMr1u9bzzEkXryNCR+Sm+rAdCQb0U4oEo0y5TPCVQGfQugYyxVmDmsBjLa8nCGeZ Ly9Ea2ROB8MUbmtf+xuUkaP4sAlr39BlJIGvLaT9iyzYGCuYibINQ2FfcoiNehoFgN 7PzmuHVrE+sov6QsunjakS8MrN80G7bpqLg3+pzFt+7k1eqIZh394FbOL0PZ8qb1o1 niM4fl3mcP6ajehOgBviEVdnJz2RVUD58T9k00wrep4p6CzIIg/ycM3bpDY7fLSySP lQ49jucsbJ5UA== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id 1E56210002E; Tue, 13 Aug 2024 20:40:05 -0400 (EDT) Received: from pastel (unknown [216.154.9.87]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id DF60E120610; Tue, 13 Aug 2024 20:40:04 -0400 (EDT) From: Stefan Monnier To: Eli Zaretskii Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: <86zfpwwyu4.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 01 Aug 2024 09:18:11 +0300") Message-ID: References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> Date: Tue, 13 Aug 2024 20:40:03 -0400 User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-SPAM-INFO: Spam detection results: 0 ALL_TRUSTED -1 Passed through trusted hosts only via SMTP AWL -0.030 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain T_SCC_BODY_TEXT_LINE -0.01 - X-SPAM-LEVEL: X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, drew.adams@oracle.com, Visuwesh X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) >> Here's a patch to make it insert "the variable " after evaluate. But >> I'm not sure if (symbolp getter) will catch all non-variable cases. >> AFAIU, GETTER can be any generalised variable. [...] > Stefan, any comments to this suggestion? Looks OK to me. Stefan From debbugs-submit-bounces@debbugs.gnu.org Tue Aug 13 22:41:11 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 02:41:12 +0000 Received: from localhost ([127.0.0.1]:45788 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se3wl-0003su-F6 for submit@debbugs.gnu.org; Tue, 13 Aug 2024 22:41:11 -0400 Received: from mail-pl1-f193.google.com ([209.85.214.193]:44202) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se3wj-0003sf-2j for 72405@debbugs.gnu.org; Tue, 13 Aug 2024 22:41:09 -0400 Received: by mail-pl1-f193.google.com with SMTP id d9443c01a7336-1fc47abc040so41108535ad.0 for <72405@debbugs.gnu.org>; Tue, 13 Aug 2024 19:40:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723603168; x=1724207968; darn=debbugs.gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=Vfr8x0MB6B2Rg/GaFFiSEMZrSEdtW15Jj4vz2fXfshA=; b=F3wyTdneIZipZUpeASWh5fBe966L0Jwwa4sIZWqr98fLf3JLlM1nNqqZeOFUBgJ7lB ECaExbXaLV47JxKwAFDt7wBy7E+abWYbRxQsuG1cIc+YIxMCfpS5uTA87M5p9K1hbHsY KVkAoaQQTNS0VAIiOqRxiN9JTHtiqE8n5sIvY6k+NU3t1jNkP/x4acONM8kvv+K9bXMk myX2iCvDSROCgUhTl+MzUv7rmiD8xLpT68Ej0pZ90ARrzo6EE6uOncvojnaV1j5T98ry HTy5ayWJstZTNdLCspVlcrzSsh4m+DaLvIy3S/kwy23OAtxCXHkeJqxNLmS553n7FAym yDnw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723603168; x=1724207968; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=Vfr8x0MB6B2Rg/GaFFiSEMZrSEdtW15Jj4vz2fXfshA=; b=ss/Ena7KwwYTUy1Nnh6L8G7z1GEqSlhgX7pWmZSt2+uZRJ0BniHMmptyms7KufAfXe 3qkeW3vikvNiP2xALEv6KuMGx9oQ9coVMx/tquoQjDUF38BnsAn6adQwzIb8Z/jjnEB1 K5hPgod/Jfl6D2qKAuQJ0AAprAGN9nWSh8o61HT59tKReOm1rQYGUhxM6wecrgOexrHT 8EK9Uk+qJKqNWrHQSXZc4E0XtNQK0EvtLUOebjsAAp4jJZF9oF+vp/gpaPION1SS84us K9s6CnJSdCs2LPuf4mhNH9Y8fDwUAA11plhnzivMSMro9nfWsSHZcaff9XA2SlMjd8sI ULJQ== X-Forwarded-Encrypted: i=1; AJvYcCVRzV4dR/byOANLRuDcai6dR6sBJ6TocQwLfL1p72W7EUJEPKPPEA+6CKqCXn8sHJbQdMAZXSz6e6vjIXRTo6SPTnJcJ5k= X-Gm-Message-State: AOJu0YwrAhovNgjtkzoK1FJR+mBCCpgk3DH5c1RmMnut2j/7HoY7QBME YTcWE93TQgaYVboAxb60QIWEbjcYFBLqf4zqqTmqFYxPmWBmPdWA X-Google-Smtp-Source: AGHT+IHxAJuVueS+1hg4FP55YOUD1XfGSgQkIKq46A3JTGOevzONXz2OT9YAJDMNEq6MXAEksbEdSA== X-Received: by 2002:a17:902:e888:b0:1fb:59e6:b0e5 with SMTP id d9443c01a7336-201d63dc35amr17975215ad.19.1723603168294; Tue, 13 Aug 2024 19:39:28 -0700 (PDT) Received: from localhost ([115.240.90.130]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201cd1bd2c4sm19945165ad.235.2024.08.13.19.39.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Aug 2024 19:39:26 -0700 (PDT) From: Visuwesh To: Stefan Monnier Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: (Stefan Monnier via's message of "Tue, 13 Aug 2024 20:40:03 -0400") References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> Date: Wed, 14 Aug 2024 08:09:20 +0530 Message-ID: <87frr7zv3b.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 72405 Cc: Eli Zaretskii , 72405@debbugs.gnu.org, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=9A=E0=AF=86=E0=AE=B5=E0=AF=8D=E0=AE=B5=E0=AE=BE=E0=AE=AF=E0=AF=8D = =E0=AE=86=E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 13, 2024] Stefan Mon= nier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" = wrote: >>> Here's a patch to make it insert "the variable " after evaluate. But >>> I'm not sure if (symbolp getter) will catch all non-variable cases. >>> AFAIU, GETTER can be any generalised variable. > [...] >> Stefan, any comments to this suggestion? > > Looks OK to me. > > > Stefan Thanks, so I've attached a properly formatted patch. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Disambiguate-minor-mode-variable-in-its-function-doc.patch >From 535ae70653745f529742993f7fc26daf00666713 Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Wed, 14 Aug 2024 08:07:15 +0530 Subject: [PATCH] Disambiguate minor-mode variable in its function docstring * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring) (easy-mmode--mode-docstring): Add "the variable" before the GETTER if it is a symbol to properly link to minor-mode variable in the *Help* buffer in the common case. (bug#72405) --- lisp/emacs-lisp/easy-mmode.el | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 944a74a91ee..5332a3b4fcf 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ easy-mmode--arg-docstring Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s`%s'. The mode's hook is called both when the mode is enabled and when it is disabled.") @@ -128,6 +128,7 @@ easy-mmode--mode-docstring easy-mmode--arg-docstring (if global "global " "") mode-pretty-name + (if (symbolp getter) "the variable " "") ;; Avoid having quotes turn into pretty quotes. (string-replace "'" "\\='" (format "%S" getter))))) (let ((start (point))) -- 2.45.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Wed Aug 14 02:13:24 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 06:13:25 +0000 Received: from localhost ([127.0.0.1]:45877 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se7G8-00016W-EM for submit@debbugs.gnu.org; Wed, 14 Aug 2024 02:13:24 -0400 Received: from eggs.gnu.org ([209.51.188.92]:40120) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se7G6-00016H-8N for 72405@debbugs.gnu.org; Wed, 14 Aug 2024 02:13:22 -0400 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 1se7FR-0007z7-9b; Wed, 14 Aug 2024 02:12:41 -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=ITrLYEWgsuToeoCzdvZlk/6aGknwAW1THlwaInornhg=; b=E+osFjnNjYNN cjQ1Er6xWBnHaVmbTKjC3d7ze5kg5j/dcFiYR/vvyhjud72zvR+vcK+IbTeFR17rkyqr11yzHyaEu MoL5bNB9Zww324iHZOAiCZ3jRL6rcUrKpuInbhRd6nHM0xq1dnzD7WzBOwjmuJ6b6p37/l8DW7tGP DFoEKOlmaReYzwgFPvw0VoIeEWczJ++lmp1vPwwmOlANJVAx0tA6HbcOqHqKlM6zPkKWN05I/brGa BnWhBkWz6fi9hWGvaSriwEgFq/sVlsELXjodcLFTkl1powOlnN7Xa0UYSXvO1qQZMIaddIwjDvYam 87m9pSReKcSLdwWYcoP5ng==; Date: Wed, 14 Aug 2024 09:12:38 +0300 Message-Id: <86le0zfx9l.fsf@gnu.org> From: Eli Zaretskii To: Visuwesh In-Reply-To: <87frr7zv3b.fsf@gmail.com> (message from Visuwesh on Wed, 14 Aug 2024 08:09:20 +0530) Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, monnier@iro.umontreal.ca, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Visuwesh > Cc: Eli Zaretskii , 72405@debbugs.gnu.org, > drew.adams@oracle.com > Date: Wed, 14 Aug 2024 08:09:20 +0530 > > Thanks, so I've attached a properly formatted patch. > > > >From 535ae70653745f529742993f7fc26daf00666713 Mon Sep 17 00:00:00 2001 > From: Visuwesh > Date: Wed, 14 Aug 2024 08:07:15 +0530 > Subject: [PATCH] Disambiguate minor-mode variable in its function docstring > > * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring) > (easy-mmode--mode-docstring): Add "the variable" before the > GETTER if it is a symbol to properly link to minor-mode variable > in the *Help* buffer in the common case. (bug#72405) > --- > lisp/emacs-lisp/easy-mmode.el | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el > index 944a74a91ee..5332a3b4fcf 100644 > --- a/lisp/emacs-lisp/easy-mmode.el > +++ b/lisp/emacs-lisp/easy-mmode.el > @@ -91,7 +91,7 @@ easy-mmode--arg-docstring > Disable the mode if ARG is a negative number. > > To check whether the minor mode is enabled in the current buffer, > -evaluate `%s'. > +evaluate %s`%s'. ^^^^^ This looks like a bug (I know it isn't, but it looks like one). Can we instead use just %s here, and generate the full string, including the "the variable" part, in the code that uses the format? Thanks. From debbugs-submit-bounces@debbugs.gnu.org Wed Aug 14 02:40:41 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 06:40:41 +0000 Received: from localhost ([127.0.0.1]:45893 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se7gX-0001kn-A9 for submit@debbugs.gnu.org; Wed, 14 Aug 2024 02:40:41 -0400 Received: from mail-pg1-f196.google.com ([209.85.215.196]:50661) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se7gU-0001kX-So for 72405@debbugs.gnu.org; Wed, 14 Aug 2024 02:40:39 -0400 Received: by mail-pg1-f196.google.com with SMTP id 41be03b00d2f7-6e7b121be30so4060223a12.1 for <72405@debbugs.gnu.org>; Tue, 13 Aug 2024 23:40:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723617538; x=1724222338; darn=debbugs.gnu.org; h=mime-version:user-agent:references:message-id:date:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=9vAZuRkOMQdy7rufniXucAkkl1dbaIwisfKjnCPT6lw=; b=WqfVe6afJLo3Xqm5dLSX3qf34CBOVJZ0m+uwu0CdTF0UchqH8jusOhphMlRFVwI3oK k69peqyP3lNVwbUPiemCM/R6bgwNftOQY41hXYZLaDc8tchuT3L7J30pCmUrkeqdB8it FOACQe3BwNEWqBljwEFXP9ARHdj7eD4b14BRPpFyk8NCAtB38leO83edtttqW+qS1i2U AGK9yjZ8r2OuHyeEvIJ+SBi+nn0phyLlu+iRQuCPekZecFsFMrVcXG5A3E7Yqv4nngsO P9bkuu/qPJbPAF1dxBNUVfDnU+YejFdF5rawAPlx5Atv8JYn332tk5vmif0wk+hFC/tQ SXQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723617538; x=1724222338; h=mime-version:user-agent:references:message-id:date:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=9vAZuRkOMQdy7rufniXucAkkl1dbaIwisfKjnCPT6lw=; b=SAAJx0zGUKtSL4hUdFncXEwN4mLON2XjAQ40nesdBY79CoQybp4q1drfJRPwq/J6kf o/vfwyLEzmkS7jK3u+9QS+OfF6SSRFP6xTSxoJKOjw2ySJ7ifiePnE4Ycd0zzbQfUZSX zEFxq27I8lbS6fIfnkoMuyOxfRjDijXxsmrDzdsquDqPLabjpRAmK6uruYqgvGsqsVNZ G2mKHexjbW1iVv2HJGGvAOCYsAtnLPx0+cWQAQpKXYfAZsA/IpnUudK4xKWLX91tZ2nP qnK4kiwZVmcqEvvefo7ulvpOeKbnswGfAPhp6p+ItPgFqMjYckhPVvrVaTtOSZ7ncNf8 oayw== X-Forwarded-Encrypted: i=1; AJvYcCVfPYZRdjYjH1lQZ1K27LOApp0b6k5PAllU1a4Xs4YzJUDQdCSp2OTZQhm98piJzvxFolE/vl5uEe2YN0zL7tB9v4UfIEg= X-Gm-Message-State: AOJu0Ywb43psrhcI5f+4Zl4DlvlElvW1MFUUsLJawj+bdyb4s5suMhuF zuUAKvQqc5WklRPbZuNHTRubX1fNPuGSXkZ0F9ys5tkp0KwNS1/C X-Google-Smtp-Source: AGHT+IENHoxbLjV16wF69Fd+F6kyl73eS5OHr7fqMRuLgi4c6Jqrz9fK26v3LnS2Hkh6QdeblBKOdw== X-Received: by 2002:a05:6a21:7185:b0:1c8:eb57:9f32 with SMTP id adf61e73a8af0-1c8eb579f4bmr2062454637.0.1723617538221; Tue, 13 Aug 2024 23:38:58 -0700 (PDT) Received: from localhost ([115.240.90.130]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201cd1b9f7esm23044965ad.207.2024.08.13.23.38.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Aug 2024 23:38:57 -0700 (PDT) From: Visuwesh To: Eli Zaretskii Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: <86le0zfx9l.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 14 Aug 2024 09:12:38 +0300") Date: Wed, 14 Aug 2024 12:08:33 +0530 Message-ID: <877ccjzk0m.fsf@gmail.com> References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> <86le0zfx9l.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, monnier@iro.umontreal.ca, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=AA=E0=AF=81=E0=AE=A4=E0=AE=A9=E0=AF=8D =E0=AE=86=E0=AE=95=E0=AE=B8= =E0=AF=8D=E0=AE=9F=E0=AF=8D 14, 2024] Eli Zaretskii wrote: >> diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.= el >> index 944a74a91ee..5332a3b4fcf 100644 >> --- a/lisp/emacs-lisp/easy-mmode.el >> +++ b/lisp/emacs-lisp/easy-mmode.el >> @@ -91,7 +91,7 @@ easy-mmode--arg-docstring >> Disable the mode if ARG is a negative number. >>=20=20 >> To check whether the minor mode is enabled in the current buffer, >> -evaluate `%s'. >> +evaluate %s`%s'. > ^^^^^ > This looks like a bug (I know it isn't, but it looks like one). Can > we instead use just %s here, and generate the full string, including > the "the variable" part, in the code that uses the format? > > Thanks. Is the attached patch fine?=20=20 --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Disambiguate-minor-mode-variable-in-its-function-doc.patch >From 335e30093d9d5b08f8ef4473b86e89c1a3175e9c Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Wed, 14 Aug 2024 08:07:15 +0530 Subject: [PATCH] Disambiguate minor-mode variable in its function docstring * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring) (easy-mmode--mode-docstring): Add "the variable" before the GETTER if it is a symbol to properly link to minor-mode variable in the *Help* buffer in the common case. (bug#72405) --- lisp/emacs-lisp/easy-mmode.el | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 944a74a91ee..96bab8487b4 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ easy-mmode--arg-docstring Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s. The mode's hook is called both when the mode is enabled and when it is disabled.") @@ -128,8 +128,11 @@ easy-mmode--mode-docstring easy-mmode--arg-docstring (if global "global " "") mode-pretty-name - ;; Avoid having quotes turn into pretty quotes. - (string-replace "'" "\\='" (format "%S" getter))))) + (concat + (when (symbolp getter) "the variable ") + (format "`%s'" + ;; Avoid having quotes turn into pretty quotes. + (string-replace "'" "\\='" (format "%S" getter))))))) (let ((start (point))) (insert argdoc) (when (fboundp 'fill-region) ;Don't break bootstrap! -- 2.45.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Wed Aug 14 02:49:08 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 06:49:08 +0000 Received: from localhost ([127.0.0.1]:45898 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se7oi-0001xI-DX for submit@debbugs.gnu.org; Wed, 14 Aug 2024 02:49:08 -0400 Received: from eggs.gnu.org ([209.51.188.92]:39250) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se7og-0001wt-7v for 72405@debbugs.gnu.org; Wed, 14 Aug 2024 02:49:07 -0400 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 1se7o2-0004xd-0M; Wed, 14 Aug 2024 02:48:26 -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=csgajIzOSC8o3CnINSiwQAcTpIN5oPWMHHY4fLRDLkU=; b=IvRMYDzA8fjA JFmGbH265+m699rBewzZNluDdKdwV3dvulYq8ixE5LGfawFf/sRaduyJaYxgbm6Qetu6/1YzFmafa J7Pu5JoPhTpw5ubeG2IIzp42Hdb1SjDQ9cgkm4yyjaLAPekRuJ04EeZQMs7RulYIFzyGPVvexbRvO R+RCNxpbnv4GrcTv+AJmEcH6fZEthc44CHt7N3egIgTy3XhYsaH5IRu/OQtWCs1BLXotCtui7Yf+T WJIdKXKRMjPvs0E7HnijaBonbnD65yl/rShMoLR1CEmTod2CfI3v6Y12SGgPCf8kspVONYm3T6hE7 xzZHTp/vRt6bx/oyzTW2+w==; Date: Wed, 14 Aug 2024 09:48:23 +0300 Message-Id: <86ed6rfvm0.fsf@gnu.org> From: Eli Zaretskii To: Visuwesh In-Reply-To: <877ccjzk0m.fsf@gmail.com> (message from Visuwesh on Wed, 14 Aug 2024 12:08:33 +0530) Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> <86le0zfx9l.fsf@gnu.org> <877ccjzk0m.fsf@gmail.com> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, monnier@iro.umontreal.ca, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Visuwesh > Cc: monnier@iro.umontreal.ca, 72405@debbugs.gnu.org, drew.adams@oracle.com > Date: Wed, 14 Aug 2024 12:08:33 +0530 > > >> +evaluate %s`%s'. > > ^^^^^ > > This looks like a bug (I know it isn't, but it looks like one). Can > > we instead use just %s here, and generate the full string, including > > the "the variable" part, in the code that uses the format? > > > > Thanks. > > Is the attached patch fine? Yes, but please use 'if' rather than 'when'. From debbugs-submit-bounces@debbugs.gnu.org Wed Aug 14 03:29:06 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 07:29:06 +0000 Received: from localhost ([127.0.0.1]:45923 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se8RO-0002wA-3e for submit@debbugs.gnu.org; Wed, 14 Aug 2024 03:29:06 -0400 Received: from mail-ot1-f65.google.com ([209.85.210.65]:47130) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se8RL-0002vg-9X for 72405@debbugs.gnu.org; Wed, 14 Aug 2024 03:29:04 -0400 Received: by mail-ot1-f65.google.com with SMTP id 46e09a7af769-7093997dffdso2473104a34.2 for <72405@debbugs.gnu.org>; Wed, 14 Aug 2024 00:28:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723620443; x=1724225243; darn=debbugs.gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=ztKuEWiLZCtIRtKYCGgACsJaw24bcSPWFTdD5sbFeSs=; b=EPbIiFY86iIZ66RESBD3M/KhSgycAR+Qg1Xjq2xvOU4rwzwKyxWpIhYmUkEqfTr7gP amR/CRroUKnNHfSG2jKugmpLpANglM9uIdCoBfWFqYU+RUjtWIqJ2AgAPCOPOMSltqDU TFZt47qejXtiDv+MbSUT4TB30x7o+gqCExiagXI41vtRn6RyV6OUntC0zKEtLyvBJUeI 89+53UfuUBHEupkWEgAws66NPrQhFazgMwvgwtRqRyQKXlKmOUORryi/xQf08SC/KHak 7kwv6VzMRq1oKaJr9wVE3UD7shWZjPKFAqNVmoPk6D2UnkncevDvXtECq9/7UQpx9j6o ncnQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723620443; x=1724225243; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=ztKuEWiLZCtIRtKYCGgACsJaw24bcSPWFTdD5sbFeSs=; b=pq5nCzy7dJZYIXxNiWakThjBVjNGAzf0XDn8N+Lm+TmLL470DmHiBiAQk2iZDUbeFy bupRVqwXRvvhJx9P66H5mfqpIlzs6cjfCaQLbnI7KWTmKUBM4CZYkz7jlnQ3iIYQnJj+ tskYZCfFzzzI8O2JzgLcOZ/ZYQs8t3aXH3NSpu7Qy4uzSEXZM/SP8yyZEjiG+P6orseb dMXcTzO78sLzhMiZAnicMA/okdfDr3emL17dHp0fIqhy/qCKn5RLMKgPk0k121hfqUfZ 3x/2l1EZHk+Jek89GiGMVbAxxVVtdUuRT8FF3rEy2XNn4P0bWWyG+Eln27zubLChNpI+ 79mQ== X-Forwarded-Encrypted: i=1; AJvYcCV2BjSa44VMgL3Qs1VbLnFfOgR60jXQCJlT5rVik6eOJZ21yGsHOOFuOuhW1a+Sd3YW4avMvrONuXzQzcebNh/Fp2/J2Ak= X-Gm-Message-State: AOJu0YxKp4L0y2QtdfZcvdbKHwlB01Pwyi8RLzZGFa6WOTdWOYSZOxTU AxloZMjy8adS7AMCOln0KD67m+Nlyf7XqHr2xLjRvt5QKIlDkw7A X-Google-Smtp-Source: AGHT+IGp0bLGQi9UU1St752ZGapEiE1Z+Yh+VfQFNsaJQKFWBQTOQ2ud/5onEq3ZuhsEi6xp2Z5T5w== X-Received: by 2002:a05:6358:70c5:b0:1ad:424:ae4 with SMTP id e5c5f4694b2df-1b1aab17edemr226276355d.2.1723620442747; Wed, 14 Aug 2024 00:27:22 -0700 (PDT) Received: from localhost ([1.7.159.70]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-710e5a43a68sm6771279b3a.126.2024.08.14.00.27.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Aug 2024 00:27:22 -0700 (PDT) From: Visuwesh To: Eli Zaretskii Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: <86ed6rfvm0.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 14 Aug 2024 09:48:23 +0300") References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> <86le0zfx9l.fsf@gnu.org> <877ccjzk0m.fsf@gmail.com> <86ed6rfvm0.fsf@gnu.org> Date: Wed, 14 Aug 2024 12:57:17 +0530 Message-ID: <87y14zy36y.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, monnier@iro.umontreal.ca, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=AA=E0=AF=81=E0=AE=A4=E0=AE=A9=E0=AF=8D =E0=AE=86=E0=AE=95=E0=AE=B8= =E0=AF=8D=E0=AE=9F=E0=AF=8D 14, 2024] Eli Zaretskii wrote: >> From: Visuwesh >> Cc: monnier@iro.umontreal.ca, 72405@debbugs.gnu.org, drew.adams@oracle= .com >> Date: Wed, 14 Aug 2024 12:08:33 +0530 >>=20 >> >> +evaluate %s`%s'. >> > ^^^^^ >> > This looks like a bug (I know it isn't, but it looks like one). Can >> > we instead use just %s here, and generate the full string, including >> > the "the variable" part, in the code that uses the format? >> > >> > Thanks. >>=20 >> Is the attached patch fine?=20=20 > > Yes, but please use 'if' rather than 'when'. Sorry, but I'm confused. I used 'when' because=20 (concat nil "xxx") ;; =3D> "xxx" But if you don't want to rely on this implicit behaviour, I turned the 'when' to 'if' in the attached patch. I hope this is what you meant. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Disambiguate-minor-mode-variable-in-its-function-doc.patch >From b390ad167f82c7e0d449437f9e464dde9ef799a4 Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Wed, 14 Aug 2024 08:07:15 +0530 Subject: [PATCH] Disambiguate minor-mode variable in its function docstring * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring) (easy-mmode--mode-docstring): Add "the variable" before the GETTER if it is a symbol to properly link to minor-mode variable in the *Help* buffer in the common case. (bug#72405) --- lisp/emacs-lisp/easy-mmode.el | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 944a74a91ee..7a014e164bd 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ easy-mmode--arg-docstring Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s. The mode's hook is called both when the mode is enabled and when it is disabled.") @@ -128,8 +128,11 @@ easy-mmode--mode-docstring easy-mmode--arg-docstring (if global "global " "") mode-pretty-name - ;; Avoid having quotes turn into pretty quotes. - (string-replace "'" "\\='" (format "%S" getter))))) + (concat + (if (symbolp getter) "the variable " "") + (format "`%s'" + ;; Avoid having quotes turn into pretty quotes. + (string-replace "'" "\\='" (format "%S" getter))))))) (let ((start (point))) (insert argdoc) (when (fboundp 'fill-region) ;Don't break bootstrap! -- 2.45.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Wed Aug 14 03:56:07 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 07:56:07 +0000 Received: from localhost ([127.0.0.1]:45966 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se8rW-0003dl-RC for submit@debbugs.gnu.org; Wed, 14 Aug 2024 03:56:07 -0400 Received: from eggs.gnu.org ([209.51.188.92]:60862) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se8rV-0003dI-AJ for 72405@debbugs.gnu.org; Wed, 14 Aug 2024 03:56:05 -0400 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 1se8qr-0006vz-1W; Wed, 14 Aug 2024 03:55:25 -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=PPxaZP3WcNPasDAm8B6thby/GwL9avPJry7rdq0DXnQ=; b=ALkb4wTsfPWY op0Gun+//nOcBH3Zm+a7KlAvSxlCVdvZAu1JPVHbs1yHPhJ4Av4XSY0zfviqrMdchE6j9vHWjZkby oKCV6rHHVgOcUyZGppdo2N+KLylNq321mheBOSjq1TQkXXQNsfuvnjN4NxjOVpDgEvmK3N3BBWEwP h6wKWgho/bn9HHLA03SHQVr184KYqltfwAko4ebCPqyDMGKybeVtlpp38m+Yd0OffQa4JiUKGqCPE f2Cltt7+dtX9MsUvYXpD8rZNzPH4SQa4sScqzM+ujmEAOSitW2xOnlg9AH+nMSec1mEWlNQkwX9Kw BVR5yZfF2fiaK2Ao9p7b2g==; Date: Wed, 14 Aug 2024 10:55:20 +0300 Message-Id: <861q2ra68n.fsf@gnu.org> From: Eli Zaretskii To: Visuwesh In-Reply-To: <87y14zy36y.fsf@gmail.com> (message from Visuwesh on Wed, 14 Aug 2024 12:57:17 +0530) Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> <86le0zfx9l.fsf@gnu.org> <877ccjzk0m.fsf@gmail.com> <86ed6rfvm0.fsf@gnu.org> <87y14zy36y.fsf@gmail.com> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, monnier@iro.umontreal.ca, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Visuwesh > Cc: monnier@iro.umontreal.ca, 72405@debbugs.gnu.org, drew.adams@oracle.com > Date: Wed, 14 Aug 2024 12:57:17 +0530 > > >> Is the attached patch fine? > > > > Yes, but please use 'if' rather than 'when'. > > Sorry, but I'm confused. I used 'when' because > > (concat nil "xxx") ;; => "xxx" Yes, of course. But 'if' also returns nil if its condition is false: (if (symbolp 1) "symbol") => nil So you can still use the original code, which uses the above behavior of 'concat', after replacing 'when' with 'if' in your original code. The reason I asked to use 'if' is that there's no reason to use 'when' here, as the BODY of 'when' will only ever be a single string. From debbugs-submit-bounces@debbugs.gnu.org Wed Aug 14 04:06:07 2024 Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 08:06:07 +0000 Received: from localhost ([127.0.0.1]:46010 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se91D-0003xe-5z for submit@debbugs.gnu.org; Wed, 14 Aug 2024 04:06:07 -0400 Received: from mail-pf1-f196.google.com ([209.85.210.196]:44322) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se91B-0003we-6s for 72405@debbugs.gnu.org; Wed, 14 Aug 2024 04:06:06 -0400 Received: by mail-pf1-f196.google.com with SMTP id d2e1a72fcca58-7104f93a20eso5309278b3a.1 for <72405@debbugs.gnu.org>; Wed, 14 Aug 2024 01:05:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723622664; x=1724227464; darn=debbugs.gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=hA7nG0FALDDZW3+UO6cWGg+jEQ6We4UzfVzLXeHvsoA=; b=Lq7FiPi0cz4BXoBXP9se5H4sdrbtzaQKCBL2scoNshgw7N/xNfaEb9DkjcSzmC0WTv lHCZ28qObOvq/FbGrk9kQXMBpK7fQuov6B5CMpApchsPCrK41nsyyHQbcV6Biey/crL9 HGppe4DjfCpdU0OlU7SXLtXMbcNITfmBZzW4B+DS5OncKLOpvjGWRnY7Spe1rUKpX1kj DI01aCBYPyfYdJ2I19UzPjFaMrhTX5qrIJCf0QaPkewBWPLl+A79jLmZMvawN5neCmYu BTtwzALvnOy5rsHqLusbGvvp6Se+gTjsLkJ6p59t9zuMghaRc6OHheBEvhJBjhXM27PP 1UDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723622664; x=1724227464; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=hA7nG0FALDDZW3+UO6cWGg+jEQ6We4UzfVzLXeHvsoA=; b=o4r/IDvHUnRaqNbQY6YqjiQWdtQHbTzYwx+8eur90ed7El/Kf0uYH6Md8tJGXNvqp0 f1znnmqefkiPT+TKnwAyv4oENORziBnJZJKXdJuKYPVxph/ewZIIdrNbs1DrBNsqkGqP nwAkLcC3UKjuRSzJK/Dryc0h4+ZBXLdfKUR2k6erPRwY3vSL0YYMagCEnkwjPjsGthIA WqsQaZzXwCA3l3nJKU/U1cSFCVEf0FbMbBact4UdYKFJWkRJCZG6fAE1YAMbFI4zKiI4 bqccP6EWjRQ+iTwvbZJbh7FtzoIjZ2V7XfvcK57nkSbcOoeUNEmWFV7j2FSZG9udP7hd 86KA== X-Forwarded-Encrypted: i=1; AJvYcCUUjxyTyBVGL7IQ23Y+Yl19GwEILG56SHTaihvCUZBXBl+ggmFjUmRzR3UsfznnaDZru7qd1g==@debbugs.gnu.org X-Gm-Message-State: AOJu0Yydu/XhukM6mQR4ZoJtz+7R5RZoCYvP0mxvsFgQi7cBulzA9Ukk /Jf0Ve4hHqdqiMmqfPDa+N+2wh1W3TUqtTe9BYsEBKUU+I+ZeEKL X-Google-Smtp-Source: AGHT+IEhyCu7qnpHdWnPxEH+SNO94daX0w4TBsIvCHuOOw8HXCJXXDfEl/YQGCh3pqsz5dzwFPP4vQ== X-Received: by 2002:a05:6a00:1785:b0:705:a450:a993 with SMTP id d2e1a72fcca58-71267119956mr2561404b3a.17.1723622664322; Wed, 14 Aug 2024 01:04:24 -0700 (PDT) Received: from localhost ([1.7.159.70]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-710e5a43593sm6804405b3a.116.2024.08.14.01.04.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Aug 2024 01:04:23 -0700 (PDT) From: Visuwesh To: Eli Zaretskii Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' In-Reply-To: <861q2ra68n.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 14 Aug 2024 10:55:20 +0300") References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> <86le0zfx9l.fsf@gnu.org> <877ccjzk0m.fsf@gmail.com> <86ed6rfvm0.fsf@gnu.org> <87y14zy36y.fsf@gmail.com> <861q2ra68n.fsf@gnu.org> Date: Wed, 14 Aug 2024 13:34:18 +0530 Message-ID: <87ttfny1h9.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 72405 Cc: 72405@debbugs.gnu.org, monnier@iro.umontreal.ca, drew.adams@oracle.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=AA=E0=AF=81=E0=AE=A4=E0=AE=A9=E0=AF=8D =E0=AE=86=E0=AE=95=E0=AE=B8= =E0=AF=8D=E0=AE=9F=E0=AF=8D 14, 2024] Eli Zaretskii wrote: >> From: Visuwesh >> Cc: monnier@iro.umontreal.ca, 72405@debbugs.gnu.org, drew.adams@oracle= .com >> Date: Wed, 14 Aug 2024 12:57:17 +0530 >>=20 >> >> Is the attached patch fine?=20=20 >> > >> > Yes, but please use 'if' rather than 'when'. >>=20 >> Sorry, but I'm confused. I used 'when' because=20 >>=20 >> (concat nil "xxx") ;; =3D> "xxx" > > Yes, of course. But 'if' also returns nil if its condition is false: > > (if (symbolp 1) "symbol") > =3D> nil > > So you can still use the original code, which uses the above behavior > of 'concat', after replacing 'when' with 'if' in your original code. > > The reason I asked to use 'if' is that there's no reason to use 'when' > here, as the BODY of 'when' will only ever be a single string. Ah, I understand now. I find using 'if' without the else-clause confusing when glancing at the code so I opted to use 'when'. Thanks for taking your time to explain what you meant. Attached patch replaces 'when' with 'if'. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Disambiguate-minor-mode-variable-in-its-function-doc.patch >From b9e134f25f7767223fe8d482a9a3b27281180b1b Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Wed, 14 Aug 2024 08:07:15 +0530 Subject: [PATCH] Disambiguate minor-mode variable in its function docstring * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring) (easy-mmode--mode-docstring): Add "the variable" before the GETTER if it is a symbol to properly link to minor-mode variable in the *Help* buffer in the common case. (bug#72405) --- lisp/emacs-lisp/easy-mmode.el | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 944a74a91ee..a140027839e 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ easy-mmode--arg-docstring Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s. The mode's hook is called both when the mode is enabled and when it is disabled.") @@ -128,8 +128,11 @@ easy-mmode--mode-docstring easy-mmode--arg-docstring (if global "global " "") mode-pretty-name - ;; Avoid having quotes turn into pretty quotes. - (string-replace "'" "\\='" (format "%S" getter))))) + (concat + (if (symbolp getter) "the variable ") + (format "`%s'" + ;; Avoid having quotes turn into pretty quotes. + (string-replace "'" "\\='" (format "%S" getter))))))) (let ((start (point))) (insert argdoc) (when (fboundp 'fill-region) ;Don't break bootstrap! -- 2.45.2 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Thu Aug 15 03:40:05 2024 Received: (at 72405-done) by debbugs.gnu.org; 15 Aug 2024 07:40:05 +0000 Received: from localhost ([127.0.0.1]:48267 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1seV5Z-0004KX-0r for submit@debbugs.gnu.org; Thu, 15 Aug 2024 03:40:05 -0400 Received: from eggs.gnu.org ([209.51.188.92]:38052) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1seV5X-0004Jv-An for 72405-done@debbugs.gnu.org; Thu, 15 Aug 2024 03:40:04 -0400 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 1seV4q-0005e8-SU; Thu, 15 Aug 2024 03:39:21 -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=NIvrv8XNq9hzFKBXP89Lq9ZLc2aXYMhKstw9CNHezg0=; b=nP9VFOym5akE HgtBMVo7Gb2rYnOxg4JiBT+VGTy07fvU4pJVXUbruaj2sbH+FXS1bcCk9K2r5Fkxd7dbSPyNovMSa Qf7wI6yP4yU2o8mtmc//WjNXjzUnUmD8MBdn6PEAhfrYUi0mkCQDVem1wy0/jgOoOQmfcUc7nG2QE rXrDXYAXNzjR2IJPU1r63n1Ly2ZWL+QC3Dl0quR9ey9+MuiYh5y3ONLzPGVMvfShzYO+pFZNtBivd nAem8XK74zXuaIJWjRM6a4pi4GHyuBAFEfRdYwak49vE5aUDlLRAAGHGnNR+8SMc+59FytathLguk QuKVIYPmhcJ2I48LbX0WXg==; Date: Thu, 15 Aug 2024 10:39:17 +0300 Message-Id: <86v8026xqy.fsf@gnu.org> From: Eli Zaretskii To: Visuwesh In-Reply-To: <87ttfny1h9.fsf@gmail.com> (message from Visuwesh on Wed, 14 Aug 2024 13:34:18 +0530) Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode' References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> <87frr7zv3b.fsf@gmail.com> <86le0zfx9l.fsf@gnu.org> <877ccjzk0m.fsf@gmail.com> <86ed6rfvm0.fsf@gnu.org> <87y14zy36y.fsf@gmail.com> <861q2ra68n.fsf@gnu.org> <87ttfny1h9.fsf@gmail.com> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 72405-done Cc: monnier@iro.umontreal.ca, drew.adams@oracle.com, 72405-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Visuwesh > Cc: monnier@iro.umontreal.ca, 72405@debbugs.gnu.org, drew.adams@oracle.com > Date: Wed, 14 Aug 2024 13:34:18 +0530 > > > The reason I asked to use 'if' is that there's no reason to use 'when' > > here, as the BODY of 'when' will only ever be a single string. > > Ah, I understand now. I find using 'if' without the else-clause > confusing when glancing at the code so I opted to use 'when'. Thanks > for taking your time to explain what you meant. Attached patch replaces > 'when' with 'if'. Thanks, installed on the emacs-30 branch, and closing the bug. From unknown Sun Jun 15 01:03:55 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Thu, 12 Sep 2024 11:24:05 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator