From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id IK2vN8UiYmPadgEAbAwnHQ (envelope-from ) for ; Wed, 02 Nov 2022 08:56:53 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id yNfNN8UiYmPweQEA9RJhRA (envelope-from ) for ; Wed, 02 Nov 2022 08:56:53 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 9A192C099 for ; Wed, 2 Nov 2022 08:56:53 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oq8bM-0005yM-0d; Wed, 02 Nov 2022 03:55:56 -0400 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 1oq8bK-0005xx-Lg for emacs-orgmode@gnu.org; Wed, 02 Nov 2022 03:55:54 -0400 Received: from mout.web.de ([212.227.15.4]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oq8bJ-00062k-16 for emacs-orgmode@gnu.org; Wed, 02 Nov 2022 03:55:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=web.de; s=s29768273; t=1667375748; bh=70BXO0lQPvWCppInhAVTu0T9/8U2Yxd/ipDxePq/8bk=; h=X-UI-Sender-Class:References:From:To:Cc:Subject:Date:In-reply-to; b=u7adcUzp/CtYlkqZlwBBD0Wn7PKJoNjqkmq50cHxVaSbRaYTtf/EYAQiol6O5rnzq tGPuCZmmcsRQwB43a2e+eZk9Bar1x6XO4i/Wx5drjzHcsGlGSwCjcRRZ+CeAjNtqpu 0BlTNlRyq0HziCLmjPLDoAKofErH2iMJFCOw5e1dXZS1lOvVhXH6gF7eW8xfe90+Hy gwdBQPlNuc0wnoR5V9lDs4Y6dF23Kfkm8Gu1ejRWmAq6xfSIpG0ELvqengCDcQU/hK sGcDhNStqAA6ipMWHEnjLYn6scBra0c3NOPhMyeTmzC/Xp2LBCU48dhL5ZIi1ryIfE L5izRir+nFx2g== X-UI-Sender-Class: 814a7b36-bfc1-4dae-8640-3722d8ec6cd6 Received: from fluss ([84.165.20.127]) by smtp.web.de (mrweb006 [213.165.67.108]) with ESMTPSA (Nemesis) id 1MnG2C-1pHk7k0mOK-00jIKO; Wed, 02 Nov 2022 08:55:48 +0100 References: <87bkpqbwef.fsf@posteo.net> <87v8nxkewc.fsf@localhost> User-agent: mu4e 1.8.11; emacs 28.1 From: "Dr. Arne Babenhauserheide" To: Ihor Radchenko Cc: Juan Manuel =?utf-8?Q?Mac=C3=ADas?= , emacs-orgmode@gnu.org Subject: Re: Docstrings and literate programming (good practices?) Date: Wed, 02 Nov 2022 08:53:48 +0100 In-reply-to: <87v8nxkewc.fsf@localhost> Message-ID: <87r0ylvlh9.fsf@web.de> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Provags-ID: V03:K1:BmoKunF45RHL7Rr+m7C8ppkc5K9t3x9FU2ZDnRn95QIr6qLB4cF ieTrdmX8e7pFBvpt5Atlxqf0lV8iKozU3nNLTSe0I7KXx7M70x+Pb0oxsCfUaT2FBtTVOnO q/+AVwEB02yC4tCivvxJOq8gj+WLsh85tGSw+gyTjugXJOqZSvhkNOsrQldIUbvYLymXxXD lV4hV5WXi78Uphr26gh2w== UI-OutboundReport: notjunk:1;M01:P0:cgLJEtcs9+g=;34oOET8uRhpWFkqShco01fxpbRM xyL1kpmvFhGdRlI0cdZXxJAewLs58hR8nfs78v/ka4rYNCY4y+pdEoZnEj3I/CJXxGh1XG7lZ r5WSQC/PdJB/HxyRdM/L19bj8i5WclIHZ21GQMa4dDuuW6n5p/3CrYVKjM+t8xzdsGcNDq71x YSXbJ/d5LgDX1TfaR7BHNXc74Rql+tp047X5vqFKGe9+bkj7x7dA2sFlNOGD74wQMf1r9inMQ 3ENuyWRYf0MV8P4W2cLchsjCerJSvHhCF7hvSIhjOAXyZ9hXGVZY/Ar2xqSSw2J3+YUkmSk/q BBOTYXrL15b1EkH70FawXUJwwn9vcuLtwuHoPUKRijWDaxzG3fEW5zKx/7TyNrx5ss2g+ieNs eTcte6Xlfh2vxd124Ft3NOe9ZhMrIHS3KB0JoptdE8lqmmvblcBYbczSWYpmBFOJBIj2Y5WG4 9XtycGPIspiVAnNEfXTCvYzLoi+jLROTj71Uds0GEy30t0jjKcuFgjZ8LZSImzUlfDZJx/HQO VZfeh++z68igtzg+lxjZ2keYai1MJpx0TbEyNXnoWix8asV3UOX11AbiW0sNsRIhL9ocxuHk7 1f11swnddXEBMXFft8NACmCVSce6bMg/t41WeArfMHji/hpWM1C0NvbUVEwGMDYw6LD6WRf/k JPvoEID4wktloQHTryCGN1E8BC7QYxZ/q4GxQN94xFYL3q6WP0xTnel3nRkhmDAQfXGTXwjhj jS6u4rlIDbBDIsA5x4oYfqpb8mzKN/1lYimo+wKXClhsQffQK65tM1CuCSGE4ZFCqZFeh/ij6 Bg//Pi9xMiI7U83Jqwv1VHGLwf1V0NacOw28i3t8zqMXadUCFqyG8zo0QKIuUftZHhUd/U6Ih 0iK1eZNL4432pGxsBT+q5HKdcvGRAwPH1/bKbnRmQ4wsCSU98LUOckNr1N3h9pE0RODssovd4 ouDqfTP+b6r4Ez30GxzBCtL9I0E= Received-SPF: pass client-ip=212.227.15.4; envelope-from=arne_bab@web.de; helo=mout.web.de X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 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_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "Emacs-orgmode" Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1667375813; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=UuAYGv/91kV24KLQQ9/5YqxCUpx8b1IMf66U5qusexc=; b=YwEgi65PSg5c3MESftvY9MfOsLXj290bvPwoSK012LpjhjyfUrjW+5yKUQBN1nW6P0bM/n WpioPhQVlYDTDVXZsn/T3nOTlDAuihDPj8AQsDl0hKF8gUN0q4T5lXmueeDfvgg+pI0jtB ny2PlqHqHoiZUywvdym2OlZYCVVRXk/gYks2Cwp4RVVSb9Xr6hUtYb4CntaUz6yKj5q2jW KvJVmAtB4hPzrVS4U3oinm13+Or7CRyCapsEM+MGs/eV4VFmUjZda1tuq17uioVVTAirNr /AQDxEcK+gFhlILa+ofF72fT5a9hp8Z2GiOxmKYAE7a49UQJoeCFKZ3eN9T7FA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1667375813; a=rsa-sha256; cv=none; b=jiQntXyCEDCBrd+hLcBJsIWvhoQDgrhUZ+sULMKW8EiNv75MVJSvX+CV7misBgntapRNe6 QvphOJ+dPshn9ufqEpTUEyfEUHuPSjNGSiXJgkL4YCjsyL6hmaGvGSod493Bb3X0tuM3NN wee8fgDSG4zWGfQU1o6ajN+UN79vFUf2BBIegBMw1shkTMdKFHM7KKy+8WCGMyOExIV0K9 UGsdzQpaXcooj5mP7ktKih0u/5bOXTPI83xjZNs4575q4d6jFzRnfc9JV/cya1Mcw9oAHz rLuQ3pqHzE1E7C3+ytTF/cVj0uY0rg/L1WUA69jEv+HzaLjXO6m4E3c91W2JMA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=web.de header.s=s29768273 header.b=u7adcUzp; dmarc=pass (policy=none) header.from=web.de; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -6.18 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=web.de header.s=s29768273 header.b=u7adcUzp; dmarc=pass (policy=none) header.from=web.de; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 9A192C099 X-Spam-Score: -6.18 X-Migadu-Scanner: scn1.migadu.com X-TUID: q88XTJiZ1aiI --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Ihor Radchenko writes: > Juan Manuel Mac=C3=ADas writes: > >> #+NAME: docstring1 >> #+begin_src org :post format-docstring(*this*) :results replace :exports= results :tangle no >> Lorem ipsum dolor sit amet. >> >> Consectetuer adipiscing elit. "Donec hendrerit tempor tellus". Donec p= retium posuere >> tellus. Proin quam nisl, tincidunt et, mattis eget, convallis nec, pur= us. Cum sociis >> natoque penatibus et magnis dis parturient montes, nascetur ridiculus = mus.=20 >> #+end_src > > You can also have > > #+name: docstring1 > : Lorem ipsum dolor sit amet. > > : > : Consectetuer adipiscing elit. "Donec hendrerit tempor tellus". Donec = pretium posuere > : tellus. Proin quam nisl, tincidunt et, mattis eget, convallis nec, pu= rus. Cum sociis > : natoque penatibus et magnis dis parturient montes, nascetur ridiculus= mus.=20 > >> #+begin_src emacs-lisp :noweb strip-export :exports code >> (defun foo () >> <> >> (message "hello world")) >> #+end_src Both of these options look awesome! Thank you for sharing! The first (org-block) for long-form text (like official javadoc), the second (just verbatim) for shorter docstrings. They finally solve a long-standing problem for me. Best wishes, Arne =2D-=20 Unpolitisch sein hei=C3=9Ft politisch sein, ohne es zu merken. draketo.de --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQJEBAEBCAAuFiEE801qEjXQSQPNItXAE++NRSQDw+sFAmNiIoMQHGFybmVfYmFi QHdlYi5kZQAKCRAT741FJAPD68FmD/kBDG34R4BHOVAkmJSTJerHgCHFlm3r3fqV PeK9bzRwPHLxMplstNoIh9PcNgHv8ejrRpQkPyUl8XCnrCMw9YDyssa/+FKrG/MK DHX0AxppSkTKDrMQydhw7LJGaE6jUyTEcOjn1zdHEyB97f0YH9O/q+LW+XB1LYBe /Dtr6809iSRIErDkE/15W2CdEffeH2zrr9aU4pfM78MSQ/37TPUfylHbmFlRlL1J Uj2KE6NHhJ1p5t7GHnwUNXD8m+E8YwdrDtb7k163A/EcuHuglZ0B/0agxmQXO97t GnU0UTzFntv5GHoouOE4X0w98/e5INi9oTVY2ye5ZeJaeeJ6sP+yDGDi7vtEQ16y OGqQ7kY0F+ckRLOkZMe4bA8eztQ5HpQoFauUECsgjgDNcJU1sSSndd3gLFmvEDE+ iwlqibD41R1M4fXaWvuXc3e07mh1hw1v7U4MikneXkPhR0c0U/trH3XSPRI9bOB7 O5e4B+GmlYGlpqecWgP3V6KrT2kIc5BuVuDJ2pk1kcRj5FxTs4kDGhOA8R+3LNpf 1AAmcHQu9Ut2vfmXbtdBKyt+2diJ3bWEoK9zPK798RrrwIOk4oGCkguStFVFaTf6 XN/55oSyHPaNCJ6ETp30+WrrsKesgjofn/yGjUgOfFn2/c5GQcFw2JKTtsL3Opu9 1IM6kYegXYjEBAEBCAAuFiEE3Si95tmHXKvOSosd3M8NswvBBUgFAmNiIoMQHGFy bmVfYmFiQHdlYi5kZQAKCRDczw2zC8EFSFnDA/40t9deUIHjVC62J+zIG33KlWID km8S45x0h1xiMps1OxZrNf7Y+P8hzmVizjXn6+H4mr7ej8LRiqXP1Axzkaj4ycWH Q9WNoQz5zgnPVUH8dSlXTu7FyOoI98mjXa3MB6NT1nkdfknIER22nX2KP3EUJQX4 jXbICDKYTdFd4ywlVA== =E5YG -----END PGP SIGNATURE----- --=-=-=--