From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Christopher Howard Newsgroups: gmane.lisp.guile.user Subject: Re: procedure docstrings / documentation Date: Sat, 23 Sep 2017 12:56:13 -0800 Message-ID: <1506200173.29597.2.camel@qlfiles.net> References: <1505953100.1041.2.camel@qlfiles.net> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/signed; micalg="pgp-sha256"; protocol="application/pgp-signature"; boundary="=-KZxTemYNIivyPyD5lxfW" X-Trace: blaine.gmane.org 1506200218 4279 195.159.176.226 (23 Sep 2017 20:56:58 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 23 Sep 2017 20:56:58 +0000 (UTC) To: Guile User Mailing List Original-X-From: guile-user-bounces+guile-user=m.gmane.org@gnu.org Sat Sep 23 22:56:53 2017 Return-path: Envelope-to: guile-user@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dvrTo-0000dZ-Fx for guile-user@m.gmane.org; Sat, 23 Sep 2017 22:56:52 +0200 Original-Received: from localhost ([::1]:36079 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dvrTu-0004ss-2y for guile-user@m.gmane.org; Sat, 23 Sep 2017 16:56:58 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:54651) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dvrTM-0004rd-7y for guile-user@gnu.org; Sat, 23 Sep 2017 16:56:25 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dvrTJ-0001Xr-7P for guile-user@gnu.org; Sat, 23 Sep 2017 16:56:24 -0400 Original-Received: from mx.kolabnow.com ([95.128.36.40]:24092) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dvrTJ-0001Wf-05 for guile-user@gnu.org; Sat, 23 Sep 2017 16:56:21 -0400 Original-Received: from localhost (unknown [127.0.0.1]) by ext-mx-out001.mykolab.com (Postfix) with ESMTP id 36BD9160D for ; Sat, 23 Sep 2017 22:56:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kolabnow.com; h= mime-version:content-type:content-type:references:in-reply-to :date:date:from:from:subject:subject:message-id:received :received:received; s=dkim20160331; t=1506200177; x=1506200199; bh=0Xrrt9IOOc/qvh0w27QJO8gZ/SvnNpPI2Z9CnVfkqlw=; b=zmwTCXtbOp/4 IO64spV+jRLRZSLgtTY2Y58r05wDYL3tOa6x6/iHbQa7mDzd+8R4pEFXsgIrzUV9 +WGBjQa3p+vDEabMdYRWf1OCXtl4L51etqDRcaxgvweUbYP7ho2tYAkwlwkS3U2A I77QZEHmKjVw8C++SOBmwyXQIIPqVXAdmldI6Ike7rDGVRV7EeSKCj99Wb1mmRYV G+5aVGIxEQ9nbthN5Bem93gudLV5Ib4TLlxOQ+xLL+uHLLwsSaYHtpFREZaA2QSC 5pIp9YI2U+QHnWi1c/tl+UtlCT4VPHumVxSX0PPYsmdbzCJfTccj9Lh8cbEK7Gej wSGRqB8hbBuJTGumgLPGyESSIeaHJv+ddlOY+/yNVHeHjDoe3wtg0MbjcUQryyr3 0FWqWDyMhftkQLR/M3fyFhU8mCEA0KZo7r7Mt4nGN9AYoAgyPnOoUJcMB0p1Wv+3 KmlFO4MbN6d05k6o9+IUXNkTF4YlJnIax8fko3QDz995ifhmiVQyyWeWBiIQcM/9 fu9kR07SzEzosLHz3U3QpiM/CPDe2x5OxDkCXb3Abui76+e X-Virus-Scanned: amavisd-new at mykolab.com Original-Received: from mx.kolabnow.com ([127.0.0.1]) by localhost (ext-mx-out001.mykolab.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dIX0gcdbuOAj for ; Sat, 23 Sep 2017 22:56:17 +0200 (CEST) Original-Received: from int-mx003.mykolab.com (unknown [10.9.13.3]) by ext-mx-out001.mykolab.com (Postfix) with ESMTPS id CA09F1603 for ; Sat, 23 Sep 2017 22:56:17 +0200 (CEST) Original-Received: from ext-subm002.mykolab.com (unknown [10.9.6.2]) by int-mx003.mykolab.com (Postfix) with ESMTPS id BC5AD99E for ; Sat, 23 Sep 2017 22:56:17 +0200 (CEST) In-Reply-To: <1505953100.1041.2.camel@qlfiles.net> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 95.128.36.40 X-BeenThere: guile-user@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: General Guile related discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-user-bounces+guile-user=m.gmane.org@gnu.org Original-Sender: "guile-user" Xref: news.gmane.org gmane.lisp.guile.user:14180 Archived-At: --=-KZxTemYNIivyPyD5lxfW Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable No thoughts related to this subject? On Wed, 2017-09-20 at 16:18 -0800, Christopher Howard wrote: > Is there any convention on content/formatting for a procedure > docstring? E.g., should I repeat the procedure name and arguments? > Should I insert newlines to maintain a certain text width? >=20 > I'm not really clear on how document is done in Guile, overall. I see > Gieser has ways to look up documention for some procedures/modules, > but > it doesn't seem to pull that information from the docstring, at least > not my docstrings. >=20 --=20 https://qlfiles.net https://emailselfdefense.fsf.org/en/ --=-KZxTemYNIivyPyD5lxfW Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- iQEzBAABCAAdFiEE3cRyrLOhI3rPcNVUee7NbCP9XMUFAlnGym0ACgkQee7NbCP9 XMUcqQf+MqtkGUuhmESQdUKjrTtlF/VqSHoHxhWCpmFQwQgSVsTY5blOhgLPJZX6 z7aQu4+1ynYc4qExTdUUCuBpDVzotxPhUXMN84Y1B17D3jgpKf01UuiC2Dvkpr0d SUZkfOtmMAxMnH0mIwj2watgwQVwmHtVOfyiwyR0eri/zQNPMWKiI3OW7n1XgA5k 870JgdjqkU2DI5tZ6L/1LEMly/52i+bmqI/SL4eXSvoJrqKpZXh2N7QfX+XuGwsw X+1AIZebCvFXBWyqWvrAVcHY5Wz+CpToCO/xNOXcnYh8WGs2F1ya2zoLlMYSrQ96 xcSAfBkA8Jj5Dv/eSJxQXVFvzJVQwQ== =m1zN -----END PGP SIGNATURE----- --=-KZxTemYNIivyPyD5lxfW--