From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Luis Felipe Newsgroups: gmane.lisp.guile.user Subject: Re: Indentation with inline comments in Emacs Date: Mon, 18 Apr 2022 14:05:34 +0000 Message-ID: References: <675f8207-b178-6cbf-24a0-6e4e53a057f2@posteo.de> <2BCF2B67-B2D8-480F-BA1C-D9A8580914FB@korwin-zmijowski.fr> <591cc2fe-6aec-37f4-4eb5-170c713b8ac1@posteo.de> <325eca55-eb2d-7a66-b5b8-9e323e3e9fc4@posteo.de> Reply-To: Luis Felipe Mime-Version: 1.0 Content-Type: multipart/signed; protocol="application/pgp-signature"; micalg=pgp-sha256; boundary="------4368b4e378480be842c3b814fe235ee98fdc5f1f3a93784ff986de65306f6d25"; charset=utf-8 Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7561"; mail-complaints-to="usenet@ciao.gmane.io" Cc: guile-user@gnu.org To: Zelphir Kaltstahl Original-X-From: guile-user-bounces+guile-user=m.gmane-mx.org@gnu.org Mon Apr 18 16:06:11 2022 Return-path: Envelope-to: guile-user@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 1ngS13-0001mg-SX for guile-user@m.gmane-mx.org; Mon, 18 Apr 2022 16:06:09 +0200 Original-Received: from localhost ([::1]:42806 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ngS12-0006Df-6t for guile-user@m.gmane-mx.org; Mon, 18 Apr 2022 10:06:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39408) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ngS0i-0006DF-FJ for guile-user@gnu.org; Mon, 18 Apr 2022 10:05:48 -0400 Original-Received: from mail-40140.protonmail.ch ([185.70.40.140]:46776) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ngS0g-0001bE-8b for guile-user@gnu.org; Mon, 18 Apr 2022 10:05:47 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail; t=1650290736; bh=z7jeBSO5EvklFWpJLtX1v7IxVHgXMJaPawOtgEF/VDQ=; h=Date:To:From:Cc:Reply-To:Subject:Message-ID:In-Reply-To: References:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID; b=riM8fiDqrqQ9tLu+SULwFBT/sezYlf4JXBJo368es4G4L0eSbasMhCPsFfOWA/Jom cnqMKNX3jCb7SEwFy2lBUmNVorbH+GjCE4YeGk5QUpTGEQxqOO0VUZC2hxROVZUM6r sVDnZ8pzk2Kat3A9v+TXeuVJxsvZ3379na62AMP6IQYJpQaab/nemUZKDQ7i5HXhOf vQYL2RQDCDDxvfKzjYZyJo9MOuzIw9q7wuOGpH/dmbKw2rr2edw9zicuq1d+SzoZMF TQwzk0gOJLqx0SS4Y4Qwg83XwfUz0sU/7xiAwoh+Fff2QtFhDy+SRDe6qzc05iOnFx CMaHmP4ksEPQA== In-Reply-To: <325eca55-eb2d-7a66-b5b8-9e323e3e9fc4@posteo.de> Received-SPF: pass client-ip=185.70.40.140; envelope-from=luis.felipe.la@protonmail.com; helo=mail-40140.protonmail.ch X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guile-user@gnu.org X-Mailman-Version: 2.1.29 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-mx.org@gnu.org Original-Sender: "guile-user" Xref: news.gmane.io gmane.lisp.guile.user:18254 Archived-At: This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --------4368b4e378480be842c3b814fe235ee98fdc5f1f3a93784ff986de65306f6d25 Content-Type: multipart/mixed;boundary=---------------------527a8a74cb3bba4e45a665d796da138e -----------------------527a8a74cb3bba4e45a665d796da138e Content-Transfer-Encoding: quoted-printable Content-Type: text/plain;charset=utf-8 On Monday, April 18th, 2022 at 10:48 AM, Zelphir Kaltstahl wrote: > I like the documentation style in the doc string you are proposing. Not = sure I > will always go to that length myself, but it would probably be a good pr= actice. > Just like you said, for generating auto-generating things like API docs.= Btw.: > What is the standard tool in the Guile ecosystem to do that from doc str= ings > like yours? None that I know of :) But I see there are pieces around that could make it possible to generate = documentation [semi]automatically: + procedure-documentation (https://www.gnu.org/software/guile/manual/guile.html#Procedure-Properti= es) + (scheme documentation) module from guile-lib (https://www.nongnu.org/guile-lib/doc/ref/scheme.documentation/) + (ice-9 documentation) module (https://git.savannah.gnu.org/cgit/guile.git/tree/module/ice-9/documenta= tion.scm) + guild doc-snarf command (although this one doesn't generate any output when passing a module wit= h docstrings) > Also thanks for the C-c C-d C-d hint. I did not know the shortcut. You're welcome :) -----------------------527a8a74cb3bba4e45a665d796da138e Content-Type: application/pgp-keys; filename="publickey - luis.felipe.la@protonmail.com - 0x12DE1598.asc"; name="publickey - luis.felipe.la@protonmail.com - 0x12DE1598.asc" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="publickey - luis.felipe.la@protonmail.com - 0x12DE1598.asc"; name="publickey - luis.felipe.la@protonmail.com - 0x12DE1598.asc" LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DSy0tLS0tDQpWZXJzaW9uOiBPcGVuUEdQLmpz IHY0LjEwLjEwDQpDb21tZW50OiBodHRwczovL29wZW5wZ3Bqcy5vcmcNCg0KeHNCTkJGOFpwVWdC Q0FETGpoMnVtMkpkbDlCUUtrZ01TZ25ISitzSGg3S3ovdlA5c3dxN0hZTEVuRmc2DQpIQjRLa3Vv V0lxTXlFSnJOYzRrNVJQSGJ4azlxQTB6a0Exd0E4eHYzakErMlVsaVFra1pSMCs0cjlLK3gNCmZZ RGx4ZHd2Sk1VRVJaUk5kb3QvZnFCaGtTYmhpVElTU3pvRUs2ZjNreHdiN3NyME9jSkx2aU5wQ0tv aw0KWVo1Rnc0UXp3Q0Y5V1hja0VmOXNFeGNGYzZDTkdLL0pCVlZaZlZocVZNa3hqUU42YnF1WW56 a3E4WVNoDQo5Z1lTOVgxdmxiZFJBeWVLUmFxNHVqSXV0aVM2djAybDRSRTZ1RjVqaXI4eC9UeDc3 NEZualBCNmdDdWwNCk5TeDZCZmhVTndZeWJ5UFB4SVhYOUpPNHZrT3ZXNE9NZVdjcW1BK1VnQ3c5 Vmk5dnJDN3lISlRGQUJFQg0KQUFITlBXeDFhWE11Wm1Wc2FYQmxMbXhoUUhCeWIzUnZibTFoYVd3 dVkyOXRJRHhzZFdsekxtWmxiR2x3DQpaUzVzWVVCd2NtOTBiMjV0WVdsc0xtTnZiVDdDd0hZRUVB RUlBQ0FGQWw4WnBVZ0dDd2tIQ0FNQ0JCVUkNCkNnSUVGZ0lCQUFJWkFRSWJBd0llQVFBS0NSQTU0 TWRqZWpuR3FWVWFCLzk3UC9WSEtwK0FiRWJMemVkNg0KUEloSHI2NGQ4ek5PN21ibG5Gd056NDlo azdKbVJZTDV2UDJWL21DMDNXSUpmU2ppdllHU2lIbkxSZURFDQpubG1VQ01mM20rMU45OGVBaXFI TkVnNmVpaTMyYXFWUWJheHYveis1OVJHZUtIMkFsdGFkcHNUQWdLVXMNCjFrL2Z0ZEJXVlplYitC QXJHYWlsREU3OHVlYiszWE15Z3ZDV2oyMWZleS81VXZiakhxUjlMNEpZVGlTbQ0Kd1l6N0hmWm8r REU3WUlzY3ptVmVoOE0xVnpDbC8xaWFoazlVRUxqQVAvalArcnVNVDlxRVd1ajJRbGxBDQpNZVBH UnpRYnFpRGhWUzhMRmRqQkhOb0tMeHlobmJERUZqSEYvNHhOcThqbFFMZkdKWjVoS2V0dForYlUN ClNXYUVYRjNoano5V1dVOGE1Sy8yTS9Ib3pzQk5CRjhacFVnQkNBREtVblJJOXl6NFJ2TnV2U09J RmxKdg0Ka2ZvSGVaci9CTGNTR1ZjU0JreDVsc0tkVnpNeDkrVWFhZUtqV3BJTyt4ZkVOc3o3YitC Vm9CTDBXcnY5DQo0aGx3V21HNXEwQWRFeVUxL2ZRc1JSN201TzFlYTZVVDNmdVVnMVZzakZaK1Iz alN5bEF0eXpJWk0wTFUNCmJXNUY2NzNLNEF1U2NGcE44TkxHVGdScjBXUWwvQm5Id2gyWFExeHFo YzZHQk92d2l3VkJqYWY1MFNIRQ0KVGlVUHBlM0pqUXl5QlpwKzhGS20rc25ScUNHWG4wSkc4bzBG WHk5V2N4dHZmUUZNTUpwOUJPMnl0Z3hIDQp6UUlwWWNKcEpadWNjbkZvcXFIOWorMXFYWE5TYTMv cU8zenU5bFN2WFR4eDZrZGgwRldUbllDeDhNZjgNCkJZL1BXL2JCT095aExDb1RrSHFsQUJFQkFB SEN3RjhFR0FFSUFBa0ZBbDhacFVnQ0d3d0FDZ2tRT2VESA0KWTNvNXhxa2VLUWYrSk1sY2JSbHdl aC9GQTFudzh6RkN4YUY1OFBOREVPOGxIOTIveHR6bndHZEF1bHpUDQpoWjQwakdURWlweWdzbnFI VjdXSFVmNDRuZVhuMkExY3ZDWis3M0tjcGFRTmg5TXA4eVduR0taWVVHa0cNCjZPZjFoRVU3OTJY WkV4a3lBODJQZ0xCTlkrVnpOWFhLQ0g3Tlh4WlFRV1Y1blhjYlVGQ1p5Slp1ZFNnUQ0KeGsxOXNR ZjRzOXZKWDZQQzY4cXdpN2FKMTduVmZyYmNNYXlScG0yT0dKWGQrdDkxVi9Mbk5wQ1JndGwzDQpq TllzQ0JGS0RDMFl4ZEEvTkNkRWsxZ2Z1akZ6bDBiQnM3KzVKYmQzelJhRTVBZmRWUXRJbG1FWERr VzYNCjB1eUVpM050Y3E1b2RYQTFubFIrZTA0NEtGdmVaekZ1Tk5lVGdzekFCcjVIaVU3MC9FbHlz dz09DQo9ejZlNw0KLS0tLS1FTkQgUEdQIFBVQkxJQyBLRVkgQkxPQ0stLS0tLQ0K -----------------------527a8a74cb3bba4e45a665d796da138e-- --------4368b4e378480be842c3b814fe235ee98fdc5f1f3a93784ff986de65306f6d25 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: ProtonMail wsBzBAEBCAAGBQJiXXAcACEJEDngx2N6OcapFiEEEt4VmH0cRaQ093DvOeDH Y3o5xqkVLwgAgXPoJI7j9KY1gfKT5cgsW1ZdgKDgVEaq6STtQoiI4JiEi5tC ZN2TSgrY3qyEMrKXECCDJlV2M72Tv9lqFy4KUnA8XJ0FEvfqNW3akzpNABcK EWTq7WC/zQkoOAIhjJQQVFXqMlJ7+g+c+eSjlokeajSyzrW7ck9VUcYYh7kF OVcImkYVUK2RGfVrP6ymCl6FU8JlZImse7in9I+8gBAF73K4iGqQzsyRuI9x 1T4VyrH8p6uT0T/EN/0O0mb1ctzJo1yAlCg8GlQDku0Ee7gzql/EiYJcGxyT c8joeFr6y8R9ViD87Xn6XHGNc9vR29OjpYKw5HynEUCXqit4nF+2Ng== =9/4p -----END PGP SIGNATURE----- --------4368b4e378480be842c3b814fe235ee98fdc5f1f3a93784ff986de65306f6d25--