From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Richard Stallman Newsgroups: gmane.emacs.devel Subject: Improving documentation for ert.el. Date: Sat, 10 Aug 2024 22:10:20 -0400 Message-ID: Reply-To: rms@gnu.org Content-Type: text/plain; charset=Utf-8 Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="24604"; mail-complaints-to="usenet@ciao.gmane.io" To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Aug 11 04:11:10 2024 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 1scy34-0006Dm-8o for ged-emacs-devel@m.gmane-mx.org; Sun, 11 Aug 2024 04:11:10 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1scy2I-0007cb-Id; Sat, 10 Aug 2024 22:10:22 -0400 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 1scy2H-0007cS-7F for emacs-devel@gnu.org; Sat, 10 Aug 2024 22:10:21 -0400 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 1scy2G-0004xk-MM for emacs-devel@gnu.org; Sat, 10 Aug 2024 22:10:20 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=Date:Subject:To:From:mime-version:in-reply-to: references; bh=GW9oWzSqm+izxUyzX8tt4uZwRpun4hXd/nj4brl6gC0=; b=gjFGlUUcK4ZsdE LZnAZcnPB890ySIjoR3oFgBpbZqSlrhXEKRm67Y7ayp3Q9zyVabhtGaQm5Xyi7nbfigM6VAVrhYZv fv19YBMESvLe1orbm/XItPl4wG73jgKQAcjjvoYF6NslRmrPh4URyL6/Kd1KNF+kKKU77bf2qcWWW 4YqKfV8ivoD4KUDRUabpe1waaSCwMP5CIbDi4shh0B8ASxjLsjbHrLpiyHHzLECeagYj6jmk7s1zx uCQGWDP7xJ9AGYYkr+VkfgjwYCwNkrZPhvSMtQW08LMbHNfnfnBcuH5Tkwd7Nhf2soJKsCC1BKsX3 a3RXUa+umU9b28KYEL/w==; Original-Received: from rms by fencepost.gnu.org with local (Exim 4.90_1) (envelope-from ) id 1scy2G-0005c4-Cv; Sat, 10 Aug 2024 22:10:20 -0400 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-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:322624 Archived-At: [[[ To any NSA and FBI agents reading my email: please consider ]]] [[[ whether defending the US Constitution against all enemies, ]]] [[[ foreign or domestic, requires you to follow Snowden's example. ]]] I started to write tests for `cond*', and found that the documentation in ert.el was unjelpful about how to run the test I had written. I read the comment at the beginning, which told me about `ert-run-tests-interactively'. But what argument should I use? The doc string of `ert-run-tests-interactively' referred me to `ert-select-tests'. The doc string of `ert-select-tests' is abstract, and may be helpful for understanding how its code works, but it is no help for a user trying to see how to call `ert-run-tests-interactively' for any specific case. I that the name defined with `ert-deftest' would have something to do with a name to specify, but was it the symbol itself or its value or somehing else? Since the comments did not say, I tried them but confusion got in the way. Eventually, after I started writing this, I tried again and that that name did work right when passed to `ert-run-tests-interactively'. I think the documentation should say this very explicitly, at the top of the file, and in `ert-run-tests-interactively', and also in `ert-select-tests'. This will be small compared with the size of ert.el. -- Dr Richard Stallman (https://stallman.org) Chief GNUisance of the GNU Project (https://gnu.org) Founder, Free Software Foundation (https://fsf.org) Internet Hall-of-Famer (https://internethalloffame.org)