From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Ludovic =?UTF-8?Q?Court=C3=A8s?= Newsgroups: gmane.lisp.guile.bugs Subject: bug#41126: [PATCH] doc: Added very minimal doc strings to (srfi srfi-9 gnu). Date: Wed, 27 May 2020 22:21:22 +0200 Message-ID: <87h7w1jfi5.fsf@gnu.org> References: <781f4e51b70f51341333c0f33fa5943e1ee8149d.camel@rdmp.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="95024"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) Cc: 41126@debbugs.gnu.org To: Dale Mellor Original-X-From: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Wed May 27 22:22:08 2020 Return-path: Envelope-to: guile-bugs@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 1je2Yx-000OcI-P0 for guile-bugs@m.gmane-mx.org; Wed, 27 May 2020 22:22:07 +0200 Original-Received: from localhost ([::1]:57720 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1je2Yw-00053w-Cl for guile-bugs@m.gmane-mx.org; Wed, 27 May 2020 16:22:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33420) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1je2Yt-00053d-0Q for bug-guile@gnu.org; Wed, 27 May 2020 16:22:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:38500) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1je2Ys-0001pf-MK for bug-guile@gnu.org; Wed, 27 May 2020 16:22:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1je2Ys-0008Qr-Ih for bug-guile@gnu.org; Wed, 27 May 2020 16:22:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Ludovic =?UTF-8?Q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: bug-guile@gnu.org Resent-Date: Wed, 27 May 2020 20:22:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 41126 X-GNU-PR-Package: guile X-GNU-PR-Keywords: patch Original-Received: via spool by 41126-submit@debbugs.gnu.org id=B41126.159061089532380 (code B ref 41126); Wed, 27 May 2020 20:22:02 +0000 Original-Received: (at 41126) by debbugs.gnu.org; 27 May 2020 20:21:35 +0000 Original-Received: from localhost ([127.0.0.1]:50046 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1je2YR-0008QC-KK for submit@debbugs.gnu.org; Wed, 27 May 2020 16:21:35 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:54176) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1je2YM-0008Ps-72 for 41126@debbugs.gnu.org; Wed, 27 May 2020 16:21:34 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:44455) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1je2YG-0001X5-G8; Wed, 27 May 2020 16:21:24 -0400 Original-Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=37056 helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1je2YG-0007j0-0S; Wed, 27 May 2020 16:21:24 -0400 In-Reply-To: <781f4e51b70f51341333c0f33fa5943e1ee8149d.camel@rdmp.org> (Dale Mellor's message of "Thu, 07 May 2020 12:54:37 +0100") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-guile@gnu.org List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Original-Sender: "bug-guile" Xref: news.gmane.io gmane.lisp.guile.bugs:9777 Archived-At: Hi Dale, Dale Mellor skribis: > * module/srfi/srfi-9/gnu.scm: Added some doc strings. [...] > (define (set-record-type-printer! type proc) > - "Set PROC as the custom printer for TYPE." > + "- Scheme Procedure: set-record-type-printer! TYPE PROC > + Set PROC as the custom printer for TYPE." The convention in Guile is to write docstrings like it was initially written. The bit you added is redundant with the function prototype, which tools like Geiser automatically print for yourself. At the =E2=80=9Craw=E2=80=9D REPL, you can also view that info: --8<---------------cut here---------------start------------->8--- scheme@(guile-user)> ,a set-record-type-printer! (srfi srfi-9 gnu): set-record-type-printer! # scheme@(guile-user)> ,d set-record-type-printer! Set PROC as the custom printer for TYPE. scheme@(guile-user)> set-record-type-printer! $9 =3D # --8<---------------cut here---------------end--------------->8--- If you wish, you can submit an updated patch that follows these conventions. Thank you, Ludo=E2=80=99.