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: Sun, 17 Apr 2022 13:44:29 +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> Reply-To: Luis Felipe Mime-Version: 1.0 Content-Type: multipart/signed; protocol="application/pgp-signature"; micalg=pgp-sha256; boundary="------0c1faa1292e759aabbb37addca3e8726f2a81562938e6b84e082599d983b6302"; charset=utf-8 Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="40030"; 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 Sun Apr 17 16:21:41 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 1ng5mX-000ACH-7Q for guile-user@m.gmane-mx.org; Sun, 17 Apr 2022 16:21:41 +0200 Original-Received: from localhost ([::1]:51176 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ng5mW-0005qq-38 for guile-user@m.gmane-mx.org; Sun, 17 Apr 2022 10:21:40 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38102) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ng5mJ-0005qP-1P for guile-user@gnu.org; Sun, 17 Apr 2022 10:21:27 -0400 Original-Received: from mail-41104.protonmail.ch ([185.70.41.104]:31888) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ng5mG-0007uM-Kt for guile-user@gnu.org; Sun, 17 Apr 2022 10:21:26 -0400 Authentication-Results: mail-41104.protonmail.ch; dkim=pass (2048-bit key) header.d=protonmail.com header.i=@protonmail.com header.b="ZakAQtZp" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail; t=1650203079; bh=GzC3neZ7SC1shhbY/nBtYBIUnCfw1GcOBF/2L3mdaUI=; 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=ZakAQtZpGL0544BAJJ6l9FkzVBTuMEopSC6xLOMzkC1ykjG060SeyRCWwdvd/5Wb7 8K5WUQ4VpSBnmCf7h0A4kaRsxQxUjTOcXSiWdzR3K9hWu+ZUOqBUYdy3VhquIFdzc3 NRDLhQQ3cv9Ur9UAQ9Dkp0YTvf7CxpHw9SP34hKEyKCfdoZ5jCrqYsEPfzx5mjdrb/ TZ6q692lfAGHhiSiqkBvbpmHhmuhFhQ8CJMbEUhdGsAWDQupB02XDtEDnPu5ef3zSQ mvab1p3LchEBHuR2jQqEcEBtTI4/zzzvhRTWoxV/tszB0TilSggZ1l4KFIERs2UHvN 1r4pvrqCCluwA== In-Reply-To: <591cc2fe-6aec-37f4-4eb5-170c713b8ac1@posteo.de> Received-SPF: pass client-ip=185.70.41.104; envelope-from=luis.felipe.la@protonmail.com; helo=mail-41104.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, 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:18249 Archived-At: This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --------0c1faa1292e759aabbb37addca3e8726f2a81562938e6b84e082599d983b6302 Content-Type: multipart/mixed;boundary=---------------------4dae38070b61541801c109c69a8b06c3 -----------------------4dae38070b61541801c109c69a8b06c3 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain;charset=utf-8 Hi Zelphir, On Sunday, April 17th, 2022 at 10:49 AM, Zelphir Kaltstahl wrote: > I have the same indentation issue though, when I use #||# comments for > arguments, which are not keyword arguments, but I want to hint what they= are > used for. One could argue, that I should rewrite the called function to = use > keyword arguments, or, if it is a library function, I should wrap it. Hm= mm. > Maybe that's a valid point. Or document the function and its parameter using a documentation string (d= ocstring) instead of comments? This way, you or the users of your code can= read that documentation with Emacs Geiser. For instance: (define (get-field record field) "Get the value of FIELD from RECORD. RECORD (Guile Record or SRFI 9 Record) A record of any type. FIELD (Symbol) The name of the field. RETURN VALUE (Anything) The value of the field. If the FIELD does not exist, a no-such-field exception is raised." (let* [(descriptor (record-type-descriptor record)) (access-field (record-accessor descriptor field))] (access-field record))) Then, in Emacs, when calling this procedure, you would place the caret in = get-field, press C-c C-d C-d, and Emacs would show its documentation in a = buffer. That's my documentation style, though, which is not conventional, but just= an example. Using documentation string is also useful if you later want to [auto]gener= ate API documentation. -----------------------4dae38070b61541801c109c69a8b06c3 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 -----------------------4dae38070b61541801c109c69a8b06c3-- --------0c1faa1292e759aabbb37addca3e8726f2a81562938e6b84e082599d983b6302 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: ProtonMail wsBzBAEBCAAGBQJiXBmpACEJEDngx2N6OcapFiEEEt4VmH0cRaQ093DvOeDH Y3o5xqmpcwgAgjU3egBy+rZgIiovDc/CMgtv14QA4eaFS4nRkASh1p5/PF7e R53pRLhIxHKVcKkl7IbSPHZOzV4YTt9EwfKiRO9N62+mQAvD4Dsd63S8sbPt vBMxtL0jFf/vuBS5X611+lmlYMtVj1bFRunM5S3W8ZdghgYI2r1zzngze4LQ K6mg4aExbzVfIjKMaNCaj5x9bNhIXBKV6htP6bGJtz8FfaXhla0zVlLU8UEQ 2Wr7RV26x/eig/2RKuv0evKZ7WycuBlU+hz8svDK9h+B5GbA3smDlHlyLeZc vpt1D119yFgDSjBWK8yidHgORKKF9Mpi4olKbBomd/oigU335Y753Q== =tXgD -----END PGP SIGNATURE----- --------0c1faa1292e759aabbb37addca3e8726f2a81562938e6b84e082599d983b6302--