From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Emanuel Berg Newsgroups: gmane.emacs.help Subject: enforce/automate docstring correctnes (was: Re: docstrings) Date: Thu, 07 Jul 2022 21:42:15 +0200 Message-ID: <87fsjcemlk.fsf_-_@dataswamp.org> References: <87h73t5gyi.fsf@web.de> <878rp5f7vh.fsf@dataswamp.org> <871qux5dbs.fsf@web.de> <87sfndkrso.fsf@web.de> <87ilo9kpdl.fsf@web.de> <87o7y0etyb.fsf_-_@dataswamp.org> <87k08oenmh.fsf@dataswamp.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17270"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) To: help-gnu-emacs@gnu.org Cancel-Lock: sha1:L/rEH/zqHPxgMpAkDQfdVfDmqNg= Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Thu Jul 07 21:42:50 2022 Return-path: Envelope-to: geh-help-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 1o9XOk-0004J4-RO for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 07 Jul 2022 21:42:50 +0200 Original-Received: from localhost ([::1]:39838 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1o9XOj-0007oM-Mg for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 07 Jul 2022 15:42:49 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35440) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o9XOL-0007oC-Nv for help-gnu-emacs@gnu.org; Thu, 07 Jul 2022 15:42:25 -0400 Original-Received: from ciao.gmane.io ([116.202.254.214]:39994) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o9XOJ-00036z-Uk for help-gnu-emacs@gnu.org; Thu, 07 Jul 2022 15:42:25 -0400 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1o9XOI-0003iy-6j for help-gnu-emacs@gnu.org; Thu, 07 Jul 2022 21:42:22 +0200 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: help-gnu-emacs@gnu.org Mail-Copies-To: never Received-SPF: pass client-ip=116.202.254.214; envelope-from=geh-help-gnu-emacs@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: -16 X-Spam_score: -1.7 X-Spam_bar: - X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.249, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:138367 Archived-At: Instead of relying on humans not forgetting anything and also getting the order and CAPS of the args the right way in the docstrings, possibly after having (checkdoc-current-buffer t) telling them about it - and incal yanking it on gmane.emacs.help - it could be both enforced and automated like this: (defun (f "Advanced Functional Programming function") ((a "AFA Doku") (o "Omega Supreme") ) (+ a o) ) Because then, not providing docstrings everywhere would not eval and `help-mode' would display it the correct way including order. It'd be a Lisp OO thing; and Emacs' claim to be "self-documenting" would ring not true but truer. ... Why, you think the code looks too bad that way? Compare (defun f (a o) "This is an Advanced Functional Programming function. A is AFA Doku. O is Omega Supreme." (+ a o) ) See? Not by much! -- underground experts united https://dataswamp.org/~incal