From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Ihor Radchenko Newsgroups: gmane.emacs.devel Subject: Re: master 48aacbf292 2/2: Make many seldom-used generalized variables obsolete Date: Sun, 11 Sep 2022 17:33:53 +0800 Message-ID: <87sfkyw8zi.fsf@localhost> References: <166111278304.2846.13033924580993120733@vcs2.savannah.gnu.org> <20220821201303.AD1E6C0088A@vcs2.savannah.gnu.org> <877d2w1ua0.fsf@tcd.ie> <87pmgojy0m.fsf@gnus.org> <87tu5fzu2r.fsf@localhost> <877d2bohgm.fsf@gnus.org> <87o7vnyaon.fsf@localhost> <8735czogfr.fsf@gnus.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="4057"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Lars Ingebrigtsen , "Basil L. Contovounesios" , emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Sep 11 11:34:53 2022 Return-path: Envelope-to: ged-emacs-devel@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 1oXJMa-0000nY-AY for ged-emacs-devel@m.gmane-mx.org; Sun, 11 Sep 2022 11:34:52 +0200 Original-Received: from localhost ([::1]:48390 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oXJMY-0006Rb-Qh for ged-emacs-devel@m.gmane-mx.org; Sun, 11 Sep 2022 05:34:50 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35568) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oXJKt-0005j9-6H for emacs-devel@gnu.org; Sun, 11 Sep 2022 05:33:07 -0400 Original-Received: from mail-pg1-x52c.google.com ([2607:f8b0:4864:20::52c]:40615) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oXJKo-0002IV-KF for emacs-devel@gnu.org; Sun, 11 Sep 2022 05:33:06 -0400 Original-Received: by mail-pg1-x52c.google.com with SMTP id r17so5591882pgr.7 for ; Sun, 11 Sep 2022 02:33:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:cc:to:from:from:to:cc:subject:date; bh=XnCM39zLKosQxfWgqks5XTeH9JJubIyG3bGPImcMK3k=; b=JbFC3xW92oiUjNjwiRCGyrj3F7AF5zJPtNEQmBNWLEgNz4pzfXmWdSUUigAYNdGvDY ry77GsYlnYQkR5oJ5IBYy2+EyxCkHX4tbLOQbOvrlqtYbso97o/JrG3DlIeh+BgYKwPD 0099i2kepyMyGoOr64AnR8l1WZE9pTuZTliUFlGjr+2Pbdcfv5aMDQ1DCnyNISg96bd/ ET26rYzvTDl9RLwK1TBDJxnSHhRlf6jEGutk1NCXlMzqroGMqyEav4jVE0FSrjcn1XDz 5tzSxZcBAv40KyrRLdP6H+B1Qxl++yeoIMB5e28KHwVoJgf2/Ug3yopg90oRMX4NehXq pXLQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date; bh=XnCM39zLKosQxfWgqks5XTeH9JJubIyG3bGPImcMK3k=; b=LExhV7N5KHUk5tbaO06ZMFEmhz1DuC1xbO4/BOjdqxsD7a49bDZbFrbtBrl4Y1O/1E HQ5NtPOsesV0LJuOwqkUMqCHaa95FnKgu//tcJ+xpaCH7tP36Lb4AvY68VycEVGuteQE cOqjr4LjVkFL5cI3MIRHC/xH7Yh0OpAgh5be5wnLe3Ujn3dA1TGsNLU/CQalp0C0rQK0 fCSohWZOPdP2Yedsr3M+jap3cMTN7239MDJ5FU9pHC1k7LF+xRB4YryFJ4qEJKmlIx/k iVMYNTBn0JExhSMWpXXMHPRfTcn2Ny4m+NUummPobIAn3fMf5yNUUdoyti4Il/J3lhXE HmTw== X-Gm-Message-State: ACgBeo3idpPw60wWmO227fEF1qJ7PKLEHtmlqPo2aM2wWg64Aa985pJC 0VN83+Ljc6DiWwrkfM+slaE= X-Google-Smtp-Source: AA6agR5AIrU951pc4IWrxch1+dxsvDwQOW4604c1KGvKoogkXrpcFttRxu7BBUggJHroEua5N9FANA== X-Received: by 2002:a63:e306:0:b0:42c:414a:95e9 with SMTP id f6-20020a63e306000000b0042c414a95e9mr19685820pgh.139.1662888779565; Sun, 11 Sep 2022 02:32:59 -0700 (PDT) Original-Received: from localhost ([2409:8a70:2bc:c850:8ec6:81ff:fe70:339d]) by smtp.gmail.com with ESMTPSA id y1-20020a17090aca8100b002029e3d5cb8sm2618851pjt.34.2022.09.11.02.32.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 11 Sep 2022 02:32:58 -0700 (PDT) In-Reply-To: Received-SPF: pass client-ip=2607:f8b0:4864:20::52c; envelope-from=yantar92@gmail.com; helo=mail-pg1-x52c.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 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, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:295166 Archived-At: Stefan Monnier writes: >>> Would it be possible to accept docstring in gv-define-setter and then >>> display it in the help buffer for the relevant variable? >> It would be possible, but then we'd just be encouraging people to write >> illegible code. > > Largely agreed. There is some occasional need for documentation of the > setter, for example we could argue that `alist-get` (when used as a gv) > should document that the ALIST argument needs to be a gv-place as > well. But when needed it can be added to the function's docstring. > So, I'm leaning towards YAGNI. I do not have anything against this paradigm. However, it would be useful then to document this convention in "12.17.2 Defining new =E2=80=98setf=E2=80=99 forms" section of the Elisp ma= nual. --=20 Ihor Radchenko, Org mode contributor, Learn more about Org mode at https://orgmode.org/. Support Org development at https://liberapay.com/org-mode, or support my work at https://liberapay.com/yantar92