From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Inferred function types in the *Help* buffer Date: Thu, 01 Jun 2023 11:53:15 +0300 Message-ID: <83v8g7d0n8.fsf@gnu.org> References: <83o7manh0e.fsf@gnu.org> <83y1l4ehpy.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="15821"; mail-complaints-to="usenet@ciao.gmane.io" Cc: akrl@sdf.org, emacs-devel@gnu.org To: Andrea Corallo Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jun 01 10:53:16 2023 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 1q4e3X-0003uT-LQ for ged-emacs-devel@m.gmane-mx.org; Thu, 01 Jun 2023 10:53:15 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q4e2w-00075Q-5r; Thu, 01 Jun 2023 04:52:38 -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 1q4e2u-000753-Kw for emacs-devel@gnu.org; Thu, 01 Jun 2023 04:52:36 -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 1q4e2u-0007Ir-B1; Thu, 01 Jun 2023 04:52:36 -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=IVjIyRKtabmbDWIW2E/7gvEIdNPayAIX6eC04feTZfM=; b=VKniOLZgXYTK 5wJ8nrzhto4ZrvuczMKI0Cnxtal/rIGFzvBpvqexjMAmV/I++DssS488xpac0NRa05ZEaUeUcxLGU p8ZdeS3P0p8wU+OvSg56DBw+OG2jJzR2zwUHZfZcBQwYrCygZF/w0KUA+VMhnbIH9g4PRDdbfVN6M 6OAK6SurjOgZLvoxbPZTWy73pLSp+Gh9v85z+VCIJG6M0qtQP9SEhJQPMTXq+ObcwPTqw3HSklsu2 d0AZahie/d3qCu+sTypMLqIVKd4tp5fMj2K+jBL61XW+T7b23PvLd2tyBNiwsUcrodf+TN0UsrpTj Bjt5GtEG20MZazOe3soExg==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q4e2q-0000XS-Ay; Thu, 01 Jun 2023 04:52:33 -0400 In-Reply-To: (message from Andrea Corallo on Thu, 01 Jun 2023 04:42:03 -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:306496 Archived-At: > From: Andrea Corallo > Cc: akrl@sdf.org, emacs-devel@gnu.org > Date: Thu, 01 Jun 2023 04:42:03 -0400 > > Eli Zaretskii writes: > > > ** Help > > ** 'describe-function' shows function inferred type when available. > > For native compiled Lisp functions 'describe-function' prints (after > > the signature) the automatically inferred function type as well. > > > > Is IMO too terse. "Inferred type" is terminology we didn't use and > > don't explain the manual, so the above doesn't really tell what kind > > of information is displayed. We should give a hint, and perhaps have > > more details in the ELisp manual, probably as part of documenting > > subr-type. > > Okay, I think I need some advise on where to get started on this so this > weekend I can try to put some effort on. Where should we add the > documentation for subr-type in the manual? I think in "What Is a Function", where we document subrp and subr-arity. If you don't feel like writing the final text, complete with markup and all, just post the raw text, and I will do the rest. Thanks.