From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.devel Subject: RE: Filling the docstring generated by define-minor-mode Date: Mon, 10 Jun 2019 13:15:04 -0700 (PDT) Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="127518"; mail-complaints-to="usenet@blaine.gmane.org" Cc: Stefan Monnier , Emacs developers To: Juanma Barranquero Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Jun 10 22:37:37 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1haR2u-000X3s-Hh for ged-emacs-devel@m.gmane.org; Mon, 10 Jun 2019 22:37:36 +0200 Original-Received: from localhost ([::1]:49528 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1haR2t-0002fM-JG for ged-emacs-devel@m.gmane.org; Mon, 10 Jun 2019 16:37:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42535) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1haQuX-00059Y-8j for emacs-devel@gnu.org; Mon, 10 Jun 2019 16:28:58 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1haQhE-00031u-3h for emacs-devel@gnu.org; Mon, 10 Jun 2019 16:15:13 -0400 Original-Received: from userp2120.oracle.com ([156.151.31.85]:51862) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1haQhD-00030c-R7 for emacs-devel@gnu.org; Mon, 10 Jun 2019 16:15:12 -0400 Original-Received: from pps.filterd (userp2120.oracle.com [127.0.0.1]) by userp2120.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x5AK8vWr005151; Mon, 10 Jun 2019 20:15:09 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=Dx1hWWX1IBSTwWPdCUc2ziizcnsUMqCBFVlTnBDEU8k=; b=ygw9M7J4B+pP5J6ULFsctLZSeV9YupC4kfoO5eWOUNipTlqePBLON8sfC3HWV8ToTcqN qVjBJ3sNgxeIeEKQYeMp3gCfjFHTu/SwEuAkibhG+OgN/PtDOjGwCagQjhXG7J8H7KSq IQua2/ru7GBO1SzIE7Scma61wKNGtjJlqxIzUl35npV3YoiyD5ALp0KHNDDrB4p7Z+vG hmElUbsBr8WkgOdU9gQKRkqgcAkUAofEOYsP7qjqGjhtgLrWdYIdqqh/ahcS5tnxZvKp RiAU9xdi0pXk2BJN+vslwmwzDKHK4SeuTFEHzpx705yCy7qbVGPXovzCQBgkQ0r+FsRq jQ== Original-Received: from aserp3020.oracle.com (aserp3020.oracle.com [141.146.126.70]) by userp2120.oracle.com with ESMTP id 2t05nqh138-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 10 Jun 2019 20:15:09 +0000 Original-Received: from pps.filterd (aserp3020.oracle.com [127.0.0.1]) by aserp3020.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x5AKE7JV148551; Mon, 10 Jun 2019 20:15:08 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserp3020.oracle.com with ESMTP id 2t0p9qwp1k-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 10 Jun 2019 20:15:08 +0000 Original-Received: from abhmp0008.oracle.com (abhmp0008.oracle.com [141.146.116.14]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id x5AKF5YS012303; Mon, 10 Jun 2019 20:15:08 GMT In-Reply-To: X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4861.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9284 signatures=668687 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1906100136 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9284 signatures=668687 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1906100136 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] X-Received-From: 156.151.31.85 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:237426 Archived-At: > > Maybe more than such a change is needed. I don't > > know what gets substituted for %s here. >=20 > The minor mode name, mostly. Which can be a single, short word, or as > long as display-fill-column-indicator, or more. Which makes finding a > good answer for any such format impractical. Presumably you mean `display-fill-column-indicator-mode', which is even worse. > > Blindly filling such stuff automatically asks for > > trouble, IMO. >=20 > Generally speaking, I agree. If we impose that here then a user defining a minor mode has zero control over it. If we don't fill blindly then users have control. They can do what they think is best. For such generated text, I think, it's best to use text that doesn't require mentioning the particular name at all, or mentions it just once, on a separate line. Trying to inject unknown names (let alone unknown arbitrary text) into some boilerplate text, and then filling the result, is a recipe for bad results. And it's not really needed, is it? The user's part of the doc string should be under her control, and the generated part should preferably not inject (i.e., %s) any text at all. That should be doable, I think.